@scalekit-sdk/node 1.0.0

package/src/organization.ts

@@ -0,0 +1,129 @@
+import { PartialMessage } from '@bufbuild/protobuf';
+import { PromiseClient } from '@connectrpc/connect';
+import GrpcConnect from './connect';
+import CoreClient from './core';
+import { OrganizationService } from './pkg/grpc/scalekit/v1/organizations/organizations_connect';
+import { CreateOrganizationResponse, GetOrganizationResponse, ListOrganizationsResponse, UpdateOrganization, UpdateOrganizationResponse } from './pkg/grpc/scalekit/v1/organizations/organizations_pb';
+
+export default class OrganizationClient {
+  private client: PromiseClient<typeof OrganizationService>;
+  constructor(
+    private readonly grpcConncet: GrpcConnect,
+    private readonly coreClient: CoreClient
+  ) {
+    this.client = this.grpcConncet.createClient(OrganizationService);
+  }
+
+  /** 
+  * Create an organization with the given name. Optionally, you can provide an external id.
+  * @param {object} options The options to create an organization
+  * @param {string} options.name The organization name
+  * @param {string} options.externalId The external id
+  * @returns {Promise<CreateOrganizationResponse>} The created organization
+  */
+  async createOrganization(options: { name: string, externalId?: string }): Promise<CreateOrganizationResponse> {
+    const { name, externalId } = options;
+    return this.coreClient.connectExec(
+      this.client.createOrganization,
+      {
+        organization: {
+          displayName: name,
+          externalId: externalId
+        }
+      }
+    )
+  }
+
+  /**
+   * List organizations with pagination
+   * @param {object} options The options to list organizations
+   * @param {number} options.pageSize The page size
+   * @param {string} options.pageToken The page token
+   * @returns {Promise<ListOrganizationResponse>} The list of organizations
+   */
+  async listOrganization(options?: {
+    pageSize?: number,
+    pageToken?: string
+  }): Promise<ListOrganizationsResponse> {
+    return this.coreClient.connectExec(
+      this.client.listOrganization,
+      options ? options : {},
+    )
+  }
+
+  /**
+   * Get an organization by id
+   * @param {string} id The organization id
+   * @returns {Promise<GetOrganizationResponse>} The organization
+   */
+  async getOrganization(id: string): Promise<GetOrganizationResponse> {
+    return this.coreClient.connectExec(
+      this.client.getOrganization,
+      { identities: { case: 'id', value: id } },
+    )
+  }
+
+  /**
+   * Get an organization by external id
+   * @param {string} externalId The external id
+   * @returns {Promise<GetOrganizationResponse>} The organization
+   */
+  async getOrganizationByExternalId(externalId: string): Promise<GetOrganizationResponse> {
+    return this.coreClient.connectExec(
+      this.client.getOrganization,
+      { identities: { case: 'externalId', value: externalId } },
+    )
+  }
+
+  /**
+   * Update an organization by id
+   * @param {string} id The organization id
+   * @param {PartialMessage<UpdateOrganization>} organization The organization to update
+   * @returns {Promise<UpdateOrganizationResponse>} The updated organization
+   */
+  async updateOrganization(id: string, organization: PartialMessage<UpdateOrganization>): Promise<UpdateOrganizationResponse> {
+    return this.coreClient.connectExec(
+      this.client.updateOrganization,
+      {
+        identities: { case: "id", value: id },
+        organization
+      },
+    )
+  }
+
+  /**
+   * Update an organization by external id
+   * @param {string} externalId The external id
+   * @param {PartialMessage<UpdateOrganization>} organization The organization to update
+   * @returns {Promise<UpdateOrganizationResponse>} The updated organization   
+   */
+  async updateOrganizationByExternalId(externalId: string, organization: PartialMessage<UpdateOrganization>): Promise<UpdateOrganizationResponse> {
+    return this.coreClient.connectExec(
+      this.client.updateOrganization,
+      {
+        identities: { case: "externalId", value: externalId, },
+        organization
+      },
+    )
+  }
+
+  /**
+   * Generate customer portal link for an organization
+   * @param organizationId  The organization id
+   * @returns {Promise<string>} The customer portal link
+   */
+  async generateCustomerPortalLink(organizationId: string): Promise<string> {
+    const response = await this.coreClient.connectExec(
+      this.client.generateCustomerPortalLink,
+      {
+        id: organizationId
+      },
+    )
+    if (!response.link) {
+      throw new Error('Error generating customer portal link');
+    }
+
+    return response.link?.location
+  }
+}
+

package/src/pkg/grpc/scalekit/v1/commons/commons_pb.ts

@@ -0,0 +1,36 @@
+// @generated by protoc-gen-es v1.8.0 with parameter "target=ts"
+// @generated from file scalekit/v1/commons/commons.proto (package scalekit.v1.commons, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { proto3 } from "@bufbuild/protobuf";
+
+/**
+ * @generated from enum scalekit.v1.commons.RegionCode
+ */
+export enum RegionCode {
+  /**
+   *
+   * If the region code is unspecified the selected region will automatically be decided based on the origin of the call.
+   *
+   * @generated from enum value: REGION_CODE_UNSPECIFIED = 0;
+   */
+  REGION_CODE_UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: US = 1;
+   */
+  US = 1,
+
+  /**
+   * @generated from enum value: EU = 2;
+   */
+  EU = 2,
+}
+// Retrieve enum metadata with: proto3.getEnumType(RegionCode)
+proto3.util.setEnumType(RegionCode, "scalekit.v1.commons.RegionCode", [
+  { no: 0, name: "REGION_CODE_UNSPECIFIED" },
+  { no: 1, name: "US" },
+  { no: 2, name: "EU" },
+]);
+

package/src/pkg/grpc/scalekit/v1/connections/connections_connect.ts

@@ -0,0 +1,80 @@
+// @generated by protoc-gen-connect-es v1.4.0 with parameter "target=ts"
+// @generated from file scalekit/v1/connections/connections.proto (package scalekit.v1.connections, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { CreateConnectionRequest, CreateConnectionResponse, DeleteConnectionRequest, DisableConnectionRequest, EnableConnectionRequest, GetConnectionRequest, GetConnectionResponse, ListConnectionsRequest, ListConnectionsResponse, ToggleConnectionResponse, UpdateConnectionRequest, UpdateConnectionResponse } from "./connections_pb.js";
+import { Empty, MethodKind } from "@bufbuild/protobuf";
+
+/**
+ * @generated from service scalekit.v1.connections.ConnectionService
+ */
+export const ConnectionService = {
+  typeName: "scalekit.v1.connections.ConnectionService",
+  methods: {
+    /**
+     * @generated from rpc scalekit.v1.connections.ConnectionService.CreateConnection
+     */
+    createConnection: {
+      name: "CreateConnection",
+      I: CreateConnectionRequest,
+      O: CreateConnectionResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc scalekit.v1.connections.ConnectionService.GetConnection
+     */
+    getConnection: {
+      name: "GetConnection",
+      I: GetConnectionRequest,
+      O: GetConnectionResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc scalekit.v1.connections.ConnectionService.ListConnections
+     */
+    listConnections: {
+      name: "ListConnections",
+      I: ListConnectionsRequest,
+      O: ListConnectionsResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc scalekit.v1.connections.ConnectionService.UpdateConnection
+     */
+    updateConnection: {
+      name: "UpdateConnection",
+      I: UpdateConnectionRequest,
+      O: UpdateConnectionResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc scalekit.v1.connections.ConnectionService.DeleteConnection
+     */
+    deleteConnection: {
+      name: "DeleteConnection",
+      I: DeleteConnectionRequest,
+      O: Empty,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc scalekit.v1.connections.ConnectionService.EnableConnection
+     */
+    enableConnection: {
+      name: "EnableConnection",
+      I: EnableConnectionRequest,
+      O: ToggleConnectionResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc scalekit.v1.connections.ConnectionService.DisableConnection
+     */
+    disableConnection: {
+      name: "DisableConnection",
+      I: DisableConnectionRequest,
+      O: ToggleConnectionResponse,
+      kind: MethodKind.Unary,
+    },
+  }
+} as const;
+