openlayer 0.20.1 → 0.21.0

package/src/resources/workspaces/invites.ts

@@ -0,0 +1,234 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Invites extends APIResource {
+  /**
+   * Invite users to a workspace.
+   *
+   * @example
+   * ```ts
+   * const invite = await client.workspaces.invites.create(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  create(
+    workspaceID: string,
+    body: InviteCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<InviteCreateResponse> {
+    return this._client.post(path`/workspaces/${workspaceID}/invites`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a list of invites in a workspace.
+   *
+   * @example
+   * ```ts
+   * const invites = await client.workspaces.invites.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  list(
+    workspaceID: string,
+    query: InviteListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<InviteListResponse> {
+    return this._client.get(path`/workspaces/${workspaceID}/invites`, { query, ...options });
+  }
+}
+
+export interface InviteCreateResponse {
+  items: Array<InviteCreateResponse.Item>;
+}
+
+export namespace InviteCreateResponse {
+  export interface Item {
+    /**
+     * The invite id.
+     */
+    id: string;
+
+    creator: Item.Creator;
+
+    /**
+     * The invite creation date.
+     */
+    dateCreated: string;
+
+    /**
+     * The invite email.
+     */
+    email: string;
+
+    /**
+     * The invite role.
+     */
+    role: 'ADMIN' | 'MEMBER' | 'VIEWER';
+
+    /**
+     * The invite status.
+     */
+    status: 'accepted' | 'pending';
+
+    workspace: Item.Workspace;
+  }
+
+  export namespace Item {
+    export interface Creator {
+      /**
+       * The invite creator id.
+       */
+      id?: string;
+
+      /**
+       * The invite creator name.
+       */
+      name?: string | null;
+
+      /**
+       * The invite creator username.
+       */
+      username?: string | null;
+    }
+
+    export interface Workspace {
+      id: string;
+
+      dateCreated: string;
+
+      memberCount: number;
+
+      name: string;
+
+      slug: string;
+    }
+  }
+}
+
+export interface InviteListResponse {
+  _meta: InviteListResponse._Meta;
+
+  items: Array<InviteListResponse.Item>;
+}
+
+export namespace InviteListResponse {
+  export interface _Meta {
+    /**
+     * The current page.
+     */
+    page: number;
+
+    /**
+     * The number of items per page.
+     */
+    perPage: number;
+
+    /**
+     * The total number of items.
+     */
+    totalItems: number;
+
+    /**
+     * The total number of pages.
+     */
+    totalPages: number;
+  }
+
+  export interface Item {
+    /**
+     * The invite id.
+     */
+    id: string;
+
+    creator: Item.Creator;
+
+    /**
+     * The invite creation date.
+     */
+    dateCreated: string;
+
+    /**
+     * The invite email.
+     */
+    email: string;
+
+    /**
+     * The invite role.
+     */
+    role: 'ADMIN' | 'MEMBER' | 'VIEWER';
+
+    /**
+     * The invite status.
+     */
+    status: 'accepted' | 'pending';
+
+    workspace: Item.Workspace;
+  }
+
+  export namespace Item {
+    export interface Creator {
+      /**
+       * The invite creator id.
+       */
+      id?: string;
+
+      /**
+       * The invite creator name.
+       */
+      name?: string | null;
+
+      /**
+       * The invite creator username.
+       */
+      username?: string | null;
+    }
+
+    export interface Workspace {
+      id: string;
+
+      dateCreated: string;
+
+      memberCount: number;
+
+      name: string;
+
+      slug: string;
+    }
+  }
+}
+
+export interface InviteCreateParams {
+  emails?: Array<string>;
+
+  /**
+   * The member role.
+   */
+  role?: 'ADMIN' | 'MEMBER' | 'VIEWER';
+}
+
+export interface InviteListParams {
+  /**
+   * The page to return in a paginated query.
+   */
+  page?: number;
+
+  /**
+   * Maximum number of items to return per page.
+   */
+  perPage?: number;
+}
+
+export declare namespace Invites {
+  export {
+    type InviteCreateResponse as InviteCreateResponse,
+    type InviteListResponse as InviteListResponse,
+    type InviteCreateParams as InviteCreateParams,
+    type InviteListParams as InviteListParams,
+  };
+}

package/src/resources/workspaces/workspaces.ts

@@ -0,0 +1,267 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as APIKeysAPI from './api-keys';
+import { APIKeyCreateParams, APIKeyCreateResponse, APIKeys } from './api-keys';
+import * as InvitesAPI from './invites';
+import {
+  InviteCreateParams,
+  InviteCreateResponse,
+  InviteListParams,
+  InviteListResponse,
+  Invites,
+} from './invites';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Workspaces extends APIResource {
+  invites: InvitesAPI.Invites = new InvitesAPI.Invites(this._client);
+  apiKeys: APIKeysAPI.APIKeys = new APIKeysAPI.APIKeys(this._client);
+
+  /**
+   * Retrieve a workspace by its ID.
+   *
+   * @example
+   * ```ts
+   * const workspace = await client.workspaces.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  retrieve(workspaceID: string, options?: RequestOptions): APIPromise<WorkspaceRetrieveResponse> {
+    return this._client.get(path`/workspaces/${workspaceID}`, options);
+  }
+
+  /**
+   * Update a workspace.
+   *
+   * @example
+   * ```ts
+   * const workspace = await client.workspaces.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  update(
+    workspaceID: string,
+    body: WorkspaceUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WorkspaceUpdateResponse> {
+    return this._client.put(path`/workspaces/${workspaceID}`, { body, ...options });
+  }
+}
+
+export interface WorkspaceRetrieveResponse {
+  /**
+   * The workspace id.
+   */
+  id: string;
+
+  /**
+   * The workspace creator id.
+   */
+  creatorId: string | null;
+
+  /**
+   * The workspace creation date.
+   */
+  dateCreated: string;
+
+  /**
+   * The workspace last updated date.
+   */
+  dateUpdated: string;
+
+  /**
+   * The number of invites in the workspace.
+   */
+  inviteCount: number;
+
+  /**
+   * The number of members in the workspace.
+   */
+  memberCount: number;
+
+  /**
+   * The workspace name.
+   */
+  name: string;
+
+  /**
+   * The end date of the current billing period.
+   */
+  periodEndDate: string | null;
+
+  /**
+   * The start date of the current billing period.
+   */
+  periodStartDate: string | null;
+
+  /**
+   * The number of projects in the workspace.
+   */
+  projectCount: number;
+
+  /**
+   * The workspace slug.
+   */
+  slug: string;
+
+  status:
+    | 'active'
+    | 'past_due'
+    | 'unpaid'
+    | 'canceled'
+    | 'incomplete'
+    | 'incomplete_expired'
+    | 'trialing'
+    | 'paused';
+
+  monthlyUsage?: Array<WorkspaceRetrieveResponse.MonthlyUsage>;
+
+  /**
+   * Whether the workspace only allows SAML authentication.
+   */
+  samlOnlyAccess?: boolean;
+
+  wildcardDomains?: Array<string>;
+}
+
+export namespace WorkspaceRetrieveResponse {
+  export interface MonthlyUsage {
+    executionTimeMs?: number | null;
+
+    monthYear?: string;
+
+    predictionCount?: number;
+  }
+}
+
+export interface WorkspaceUpdateResponse {
+  /**
+   * The workspace id.
+   */
+  id: string;
+
+  /**
+   * The workspace creator id.
+   */
+  creatorId: string | null;
+
+  /**
+   * The workspace creation date.
+   */
+  dateCreated: string;
+
+  /**
+   * The workspace last updated date.
+   */
+  dateUpdated: string;
+
+  /**
+   * The number of invites in the workspace.
+   */
+  inviteCount: number;
+
+  /**
+   * The number of members in the workspace.
+   */
+  memberCount: number;
+
+  /**
+   * The workspace name.
+   */
+  name: string;
+
+  /**
+   * The end date of the current billing period.
+   */
+  periodEndDate: string | null;
+
+  /**
+   * The start date of the current billing period.
+   */
+  periodStartDate: string | null;
+
+  /**
+   * The number of projects in the workspace.
+   */
+  projectCount: number;
+
+  /**
+   * The workspace slug.
+   */
+  slug: string;
+
+  status:
+    | 'active'
+    | 'past_due'
+    | 'unpaid'
+    | 'canceled'
+    | 'incomplete'
+    | 'incomplete_expired'
+    | 'trialing'
+    | 'paused';
+
+  monthlyUsage?: Array<WorkspaceUpdateResponse.MonthlyUsage>;
+
+  /**
+   * Whether the workspace only allows SAML authentication.
+   */
+  samlOnlyAccess?: boolean;
+
+  wildcardDomains?: Array<string>;
+}
+
+export namespace WorkspaceUpdateResponse {
+  export interface MonthlyUsage {
+    executionTimeMs?: number | null;
+
+    monthYear?: string;
+
+    predictionCount?: number;
+  }
+}
+
+export interface WorkspaceUpdateParams {
+  /**
+   * The workspace invite code.
+   */
+  inviteCode?: string;
+
+  /**
+   * The workspace name.
+   */
+  name?: string;
+
+  /**
+   * The workspace slug.
+   */
+  slug?: string;
+}
+
+Workspaces.Invites = Invites;
+Workspaces.APIKeys = APIKeys;
+
+export declare namespace Workspaces {
+  export {
+    type WorkspaceRetrieveResponse as WorkspaceRetrieveResponse,
+    type WorkspaceUpdateResponse as WorkspaceUpdateResponse,
+    type WorkspaceUpdateParams as WorkspaceUpdateParams,
+  };
+
+  export {
+    Invites as Invites,
+    type InviteCreateResponse as InviteCreateResponse,
+    type InviteListResponse as InviteListResponse,
+    type InviteCreateParams as InviteCreateParams,
+    type InviteListParams as InviteListParams,
+  };
+
+  export {
+    APIKeys as APIKeys,
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyCreateParams as APIKeyCreateParams,
+  };
+}

package/src/resources/workspaces.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './workspaces/index';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.20.1'; // x-release-please-version
+export const VERSION = '0.21.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.20.1";
+export declare const VERSION = "0.21.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.20.1";
+export declare const VERSION = "0.21.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.20.1'; // x-release-please-version
+exports.VERSION = '0.21.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.20.1'; // x-release-please-version
+export const VERSION = '0.21.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map