@iblai/iblai-api 3.34.5-core

package/src/services/CoreService.ts

@@ -0,0 +1,487 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ImageUpload } from '../models/ImageUpload';
+import type { LtiKey } from '../models/LtiKey';
+import type { LtiTool } from '../models/LtiTool';
+import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
+import type { PlatformPublicMetadata } from '../models/PlatformPublicMetadata';
+import type { RedirectTokenRequest } from '../models/RedirectTokenRequest';
+import type { RedirectTokenResponse } from '../models/RedirectTokenResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class CoreService {
+    /**
+     * List your LTI Provider Key's
+     * @param platformKey Platform Key
+     * @returns LtiKey
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiKeysList(
+        platformKey: string,
+    ): CancelablePromise<Array<LtiKey>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/lti/1p3/provider/lti-keys/',
+            query: {
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Create a new LTI Provider Key
+     * @param requestBody
+     * @returns LtiKey
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiKeysCreate(
+        requestBody: LtiKey,
+    ): CancelablePromise<LtiKey> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/lti/1p3/provider/lti-keys/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Get details about a specific LTI Provider Key
+     * @param id
+     * @param platformKey Platform Key
+     * @returns LtiKey
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiKeysRetrieve(
+        id: string,
+        platformKey: string,
+    ): CancelablePromise<LtiKey> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/lti/1p3/provider/lti-keys/{id}/',
+            path: {
+                'id': id,
+            },
+            query: {
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Update an LTI Provider Key
+     * @param id
+     * @param requestBody
+     * @returns LtiKey
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiKeysUpdate(
+        id: string,
+        requestBody: LtiKey,
+    ): CancelablePromise<LtiKey> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/core/lti/1p3/provider/lti-keys/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete an LTI Provider Key
+     *
+     * **DANGER:** Deleting a key will also delete all Tools that reference that Key. If you need to delete a Key you should first create a new one and update all Tools to reference the new Key before deleting the old one.
+     * @param id
+     * @param platformKey Platform Key
+     * @returns void
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiKeysDestroy(
+        id: string,
+        platformKey: string,
+    ): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/core/lti/1p3/provider/lti-keys/{id}/',
+            path: {
+                'id': id,
+            },
+            query: {
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * List your LTI Tool's
+     * @param platformKey Platform Key
+     * @returns LtiTool
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiToolsList(
+        platformKey: string,
+    ): CancelablePromise<Array<LtiTool>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/lti/1p3/provider/lti-tools/',
+            query: {
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Create a new LTI Tool
+     * @param requestBody
+     * @returns LtiTool
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiToolsCreate(
+        requestBody: LtiTool,
+    ): CancelablePromise<LtiTool> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/lti/1p3/provider/lti-tools/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Get details about a specific LTI Tool
+     * @param id
+     * @param platformKey Platform Key
+     * @returns LtiTool
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiToolsRetrieve(
+        id: string,
+        platformKey: string,
+    ): CancelablePromise<LtiTool> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/lti/1p3/provider/lti-tools/{id}/',
+            path: {
+                'id': id,
+            },
+            query: {
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Update an LTI Tool
+     * @param id
+     * @param requestBody
+     * @returns LtiTool
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiToolsUpdate(
+        id: string,
+        requestBody: LtiTool,
+    ): CancelablePromise<LtiTool> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/core/lti/1p3/provider/lti-tools/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete an LTI Tool
+     * @param id
+     * @param platformKey Platform Key
+     * @returns void
+     * @throws ApiError
+     */
+    public static coreLti1P3ProviderLtiToolsDestroy(
+        id: string,
+        platformKey: string,
+    ): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/core/lti/1p3/provider/lti-tools/{id}/',
+            path: {
+                'id': id,
+            },
+            query: {
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Get platform logo
+     * @param org
+     * @returns any
+     * @throws ApiError
+     */
+    public static coreOrgsDarkModeLogoRetrieve(
+        org: string,
+    ): CancelablePromise<Record<string, any>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/orgs/{org}/dark-mode-logo/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Upload a new platform logo
+     * @param org
+     * @param requestBody
+     * @returns ImageUpload
+     * @throws ApiError
+     */
+    public static coreOrgsDarkModeLogoCreateCreate(
+        org: string,
+        requestBody: ImageUpload,
+    ): CancelablePromise<ImageUpload> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/orgs/{org}/dark-mode-logo/create/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Get platform logo
+     * @param org
+     * @returns any
+     * @throws ApiError
+     */
+    public static coreOrgsFaviconRetrieve(
+        org: string,
+    ): CancelablePromise<Record<string, any>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/orgs/{org}/favicon/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Upload a new platform logo
+     * @param org
+     * @param requestBody
+     * @returns ImageUpload
+     * @throws ApiError
+     */
+    public static coreOrgsFaviconCreateCreate(
+        org: string,
+        requestBody: ImageUpload,
+    ): CancelablePromise<ImageUpload> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/orgs/{org}/favicon/create/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Get platform logo
+     * @param org
+     * @returns any
+     * @throws ApiError
+     */
+    public static coreOrgsLogoRetrieve(
+        org: string,
+    ): CancelablePromise<Record<string, any>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/orgs/{org}/logo/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Upload a new platform logo
+     * @param org
+     * @param requestBody
+     * @returns ImageUpload
+     * @throws ApiError
+     */
+    public static coreOrgsLogoCreateCreate(
+        org: string,
+        requestBody: ImageUpload,
+    ): CancelablePromise<ImageUpload> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/orgs/{org}/logo/create/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * @param org
+     * @returns PlatformPublicMetadata
+     * @throws ApiError
+     */
+    public static coreOrgsMetadataRetrieve(
+        org: string,
+    ): CancelablePromise<PlatformPublicMetadata> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/orgs/{org}/metadata/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * @param org
+     * @param requestBody
+     * @returns PlatformPublicMetadata
+     * @throws ApiError
+     */
+    public static coreOrgsMetadataUpdate(
+        org: string,
+        requestBody?: PlatformPublicMetadata,
+    ): CancelablePromise<PlatformPublicMetadata> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/core/orgs/{org}/metadata/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * @param org
+     * @param requestBody
+     * @returns PlatformPublicMetadata
+     * @throws ApiError
+     */
+    public static coreOrgsMetadataPartialUpdate(
+        org: string,
+        requestBody?: PatchedPlatformPublicMetadata,
+    ): CancelablePromise<PlatformPublicMetadata> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/core/orgs/{org}/metadata/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Creates redirect tokens for a URL specified by for a platform
+     * @param org
+     * @param requestBody
+     * @returns RedirectTokenResponse
+     * @throws ApiError
+     */
+    public static coreOrgsRedirectTokensCreate(
+        org: string,
+        requestBody: RedirectTokenRequest,
+    ): CancelablePromise<RedirectTokenResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/orgs/{org}/redirect-tokens/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Returns Redirect URL for the token specified.
+     *
+     * ```
+     * Requires user to be a member of the platform with the token passed
+     * ```
+     * @param org
+     * @param redirectToken
+     * @returns RedirectTokenResponse
+     * @throws ApiError
+     */
+    public static coreOrgsRedirectTokensRetrieve(
+        org: string,
+        redirectToken: string,
+    ): CancelablePromise<RedirectTokenResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/orgs/{org}/redirect-tokens/{redirect_token}/',
+            path: {
+                'org': org,
+                'redirect_token': redirectToken,
+            },
+        });
+    }
+    /**
+     * Delete specific token
+     * @param org
+     * @param redirectToken
+     * @returns void
+     * @throws ApiError
+     */
+    public static coreOrgsRedirectTokensDeleteDestroy(
+        org: string,
+        redirectToken: string,
+    ): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/core/orgs/{org}/redirect-tokens/{redirect_token}/delete',
+            path: {
+                'org': org,
+                'redirect_token': redirectToken,
+            },
+        });
+    }
+    /**
+     * Get platform logo
+     * @param org
+     * @returns any
+     * @throws ApiError
+     */
+    public static coreOrgsThumbnailRetrieve(
+        org: string,
+    ): CancelablePromise<Record<string, any>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/core/orgs/{org}/thumbnail/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Upload a new platform logo
+     * @param org
+     * @param requestBody
+     * @returns ImageUpload
+     * @throws ApiError
+     */
+    public static coreOrgsThumbnailCreateCreate(
+        org: string,
+        requestBody: ImageUpload,
+    ): CancelablePromise<ImageUpload> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/core/orgs/{org}/thumbnail/create/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}