@augstash/sdk 0.2.0 → 0.3.0

package/dist/generated/src/apis/ScimDiscoveryApi.js

@@ -0,0 +1,158 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScimDiscoveryApi = void 0;
+const runtime = __importStar(require("../runtime"));
+/**
+ *
+ */
+class ScimDiscoveryApi extends runtime.BaseAPI {
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: resource types
+     */
+    async resourceTypesRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/scim/v2/ResourceTypes`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response);
+    }
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: resource types
+     */
+    async resourceTypes(initOverrides) {
+        const response = await this.resourceTypesRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: schemas
+     */
+    async schemasRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/scim/v2/Schemas`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response);
+    }
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: schemas
+     */
+    async schemas(initOverrides) {
+        const response = await this.schemasRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: service provider configuration
+     */
+    async serviceProviderConfigRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/scim/v2/ServiceProviderConfig`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response);
+    }
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: service provider configuration
+     */
+    async serviceProviderConfig(initOverrides) {
+        const response = await this.serviceProviderConfigRaw(initOverrides);
+        return await response.value();
+    }
+}
+exports.ScimDiscoveryApi = ScimDiscoveryApi;

package/dist/generated/src/apis/ScimGroupApi.d.ts

@@ -0,0 +1,204 @@
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ListResponseScimGroupResource, PatchRequest, ScimGroupResource } from '../models/index';
+export interface CreateScimV2Request {
+    scimGroupResource: ScimGroupResource;
+    xIdempotencyKey?: string;
+}
+export interface DeleteScimV2Request {
+    id: string;
+    xIdempotencyKey?: string;
+}
+export interface GetScimV2Request {
+    id: string;
+}
+export interface ListScimV2Request {
+    filter?: string;
+    startIndex?: number;
+    count?: number;
+}
+export interface PatchScimV2Request {
+    id: string;
+    patchRequest: PatchRequest;
+    xIdempotencyKey?: string;
+}
+export interface ReplaceScimV2Request {
+    id: string;
+    scimGroupResource: ScimGroupResource;
+    xIdempotencyKey?: string;
+}
+/**
+ * ScimGroupApi - interface
+ *
+ * @export
+ * @interface ScimGroupApiInterface
+ */
+export interface ScimGroupApiInterface {
+    /**
+     * Writes < 500ms. displayName is matched (case-insensitively) against this workspace\'s role names; a match makes the group grant that role to every sub-user member, no match stores it unmapped. Members that are not users of this workspace are dropped rather than stored. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: create a group
+     * @param {ScimGroupResource} scimGroupResource
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimGroupApiInterface
+     */
+    createScimV2Raw(requestParameters: CreateScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimGroupResource>>;
+    /**
+     * Writes < 500ms. displayName is matched (case-insensitively) against this workspace\'s role names; a match makes the group grant that role to every sub-user member, no match stores it unmapped. Members that are not users of this workspace are dropped rather than stored. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: create a group
+     */
+    createScimV2(requestParameters: CreateScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimGroupResource>;
+    /**
+     * Writes < 300ms. Removes the mapping row. Members keep whatever role they hold — a deleted group is not a demotion; remove the members first if it should be. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: delete a group
+     * @param {string} id
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimGroupApiInterface
+     */
+    deleteScimV2Raw(requestParameters: DeleteScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Writes < 300ms. Removes the mapping row. Members keep whatever role they hold — a deleted group is not a demotion; remove the members first if it should be. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: delete a group
+     */
+    deleteScimV2(requestParameters: DeleteScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: get a group
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimGroupApiInterface
+     */
+    getScimV2Raw(requestParameters: GetScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimGroupResource>>;
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: get a group
+     */
+    getScimV2(requestParameters: GetScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimGroupResource>;
+    /**
+     * Reads < 300ms. Supports filter=displayName eq \"…\", externalId eq \"…\" and id eq \"…\", plus startIndex / count paging (max 200) with no filter. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: list or filter groups
+     * @param {string} [filter]
+     * @param {number} [startIndex]
+     * @param {number} [count]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimGroupApiInterface
+     */
+    listScimV2Raw(requestParameters: ListScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseScimGroupResource>>;
+    /**
+     * Reads < 300ms. Supports filter=displayName eq \"…\", externalId eq \"…\" and id eq \"…\", plus startIndex / count paging (max 200) with no filter. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: list or filter groups
+     */
+    listScimV2(requestParameters: ListScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseScimGroupResource>;
+    /**
+     * Writes < 500ms. members add / remove / replace (pathless, path=members, or members[value eq \"<id>\"]), displayName and externalId replace. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: patch a group
+     * @param {string} id
+     * @param {PatchRequest} patchRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimGroupApiInterface
+     */
+    patchScimV2Raw(requestParameters: PatchScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimGroupResource>>;
+    /**
+     * Writes < 500ms. members add / remove / replace (pathless, path=members, or members[value eq \"<id>\"]), displayName and externalId replace. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: patch a group
+     */
+    patchScimV2(requestParameters: PatchScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimGroupResource>;
+    /**
+     * Writes < 500ms. Name, externalId and the whole member list. Joiners gain the mapped role, leavers lose it if it was the one this group granted. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary SCIM: replace a group
+     * @param {string} id
+     * @param {ScimGroupResource} scimGroupResource
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScimGroupApiInterface
+     */
+    replaceScimV2Raw(requestParameters: ReplaceScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimGroupResource>>;
+    /**
+     * Writes < 500ms. Name, externalId and the whole member list. Joiners gain the mapped role, leavers lose it if it was the one this group granted. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: replace a group
+     */
+    replaceScimV2(requestParameters: ReplaceScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimGroupResource>;
+}
+/**
+ *
+ */
+export declare class ScimGroupApi extends runtime.BaseAPI implements ScimGroupApiInterface {
+    /**
+     * Writes < 500ms. displayName is matched (case-insensitively) against this workspace\'s role names; a match makes the group grant that role to every sub-user member, no match stores it unmapped. Members that are not users of this workspace are dropped rather than stored. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: create a group
+     */
+    createScimV2Raw(requestParameters: CreateScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimGroupResource>>;
+    /**
+     * Writes < 500ms. displayName is matched (case-insensitively) against this workspace\'s role names; a match makes the group grant that role to every sub-user member, no match stores it unmapped. Members that are not users of this workspace are dropped rather than stored. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: create a group
+     */
+    createScimV2(requestParameters: CreateScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimGroupResource>;
+    /**
+     * Writes < 300ms. Removes the mapping row. Members keep whatever role they hold — a deleted group is not a demotion; remove the members first if it should be. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: delete a group
+     */
+    deleteScimV2Raw(requestParameters: DeleteScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Writes < 300ms. Removes the mapping row. Members keep whatever role they hold — a deleted group is not a demotion; remove the members first if it should be. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: delete a group
+     */
+    deleteScimV2(requestParameters: DeleteScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: get a group
+     */
+    getScimV2Raw(requestParameters: GetScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimGroupResource>>;
+    /**
+     * Reads < 300ms. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: get a group
+     */
+    getScimV2(requestParameters: GetScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimGroupResource>;
+    /**
+     * Reads < 300ms. Supports filter=displayName eq \"…\", externalId eq \"…\" and id eq \"…\", plus startIndex / count paging (max 200) with no filter. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: list or filter groups
+     */
+    listScimV2Raw(requestParameters: ListScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseScimGroupResource>>;
+    /**
+     * Reads < 300ms. Supports filter=displayName eq \"…\", externalId eq \"…\" and id eq \"…\", plus startIndex / count paging (max 200) with no filter. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: list or filter groups
+     */
+    listScimV2(requestParameters?: ListScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseScimGroupResource>;
+    /**
+     * Writes < 500ms. members add / remove / replace (pathless, path=members, or members[value eq \"<id>\"]), displayName and externalId replace. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: patch a group
+     */
+    patchScimV2Raw(requestParameters: PatchScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimGroupResource>>;
+    /**
+     * Writes < 500ms. members add / remove / replace (pathless, path=members, or members[value eq \"<id>\"]), displayName and externalId replace. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: patch a group
+     */
+    patchScimV2(requestParameters: PatchScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimGroupResource>;
+    /**
+     * Writes < 500ms. Name, externalId and the whole member list. Joiners gain the mapped role, leavers lose it if it was the one this group granted. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: replace a group
+     */
+    replaceScimV2Raw(requestParameters: ReplaceScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScimGroupResource>>;
+    /**
+     * Writes < 500ms. Name, externalId and the whole member list. Joiners gain the mapped role, leavers lose it if it was the one this group granted. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * SCIM: replace a group
+     */
+    replaceScimV2(requestParameters: ReplaceScimV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScimGroupResource>;
+}