richie 2.25.0b2.dev68__tar.gz → 2.25.0b2.dev69__tar.gz

richie-2.25.0b2.dev69/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.1
+Name: richie
+Version: 2.25.0b2.dev69
+Summary: A CMS to build learning portals for open education
+Author-email: "Open FUN (France Université Numérique)" <fun.dev@fun-mooc.fr>
+License: MIT License
+        
+        Copyright (c) 2018-present GIP FUN MOOC.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+        
+Project-URL: Bug Tracker, https://github.com/openfun/richie/issues/new
+Project-URL: Changelog, https://github.com/openfun/richie/blob/master/CHANGELOG.md
+Project-URL: Homepage, https://github.com/openfun/richie
+Project-URL: Repository, https://github.com/openfun/richie
+Project-URL: Documentation, https://richie.education/
+Project-URL: Demonstration website, https://demo.richie.education/
+Keywords: Django,Django-CMS,Open edX
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 2.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: arrow
+Requires-Dist: Django<4
+Requires-Dist: djangocms-file
+Requires-Dist: djangocms-googlemap
+Requires-Dist: djangocms-link
+Requires-Dist: djangocms-picture
+Requires-Dist: djangocms-text-ckeditor
+Requires-Dist: djangocms-video
+Requires-Dist: djangorestframework
+Requires-Dist: django-autocomplete-light==3.9.7
+Requires-Dist: django-cms<4.0.0,>=3.11.0
+Requires-Dist: django-parler>=2.3
+Requires-Dist: django-redis>=4.11.0
+Requires-Dist: django-treebeard
+Requires-Dist: dj-pagination
+Requires-Dist: easy_thumbnails[svg]>=2.8
+Requires-Dist: elasticsearch<7.0.0,>=6.0.0
+Requires-Dist: exrex==0.11.0
+Requires-Dist: importlib-metadata
+Requires-Dist: oauthlib==3.2.2
+Requires-Dist: requests==2.31.0
+Provides-Extra: dev
+Requires-Dist: bandit==1.7.7; extra == "dev"
+Requires-Dist: black==24.1.1; extra == "dev"
+Requires-Dist: pyRdfa3==3.6.2; extra == "dev"
+Requires-Dist: cssselect==1.2.0; extra == "dev"
+Requires-Dist: factory-boy==3.3.0; extra == "dev"
+Requires-Dist: flake8==7.0.0; extra == "dev"
+Requires-Dist: flake8-pyproject==1.2.3; extra == "dev"
+Requires-Dist: htmlmin==0.1.12; extra == "dev"
+Requires-Dist: ipdb==0.13.13; extra == "dev"
+Requires-Dist: ipython==8.21.0; extra == "dev"
+Requires-Dist: isort==5.13.2; extra == "dev"
+Requires-Dist: lxml==5.1.0; extra == "dev"
+Requires-Dist: msgpack==1.0.7; extra == "dev"
+Requires-Dist: mysqlclient==2.2.4; extra == "dev"
+Requires-Dist: pylint==3.0.3; extra == "dev"
+Requires-Dist: pylint-django==2.5.5; extra == "dev"
+Requires-Dist: pytest==8.0.0; extra == "dev"
+Requires-Dist: pytest-cov==4.1.0; extra == "dev"
+Requires-Dist: pytest-django==4.8.0; extra == "dev"
+Requires-Dist: responses==0.24.1; extra == "dev"
+Provides-Extra: ci
+Requires-Dist: twine==4.0.2; extra == "ci"
+Provides-Extra: sandbox
+Requires-Dist: django-configurations==2.5; extra == "sandbox"
+Requires-Dist: dockerflow==2024.1.0; extra == "sandbox"
+Requires-Dist: factory-boy==3.3.0; extra == "sandbox"
+Requires-Dist: gunicorn==21.2.0; extra == "sandbox"
+Requires-Dist: psycopg2-binary==2.9.9; extra == "sandbox"
+Requires-Dist: sentry-sdk==1.40.3; extra == "sandbox"
+
+# Richie, the best OpenSource CMS to build education portals
+
+[![CircleCI](https://circleci.com/gh/openfun/richie/tree/master.svg?style=svg)](https://circleci.com/gh/openfun/richie/tree/master)
+
+## Overview
+
+`Learning Management Systems` (LMS) are great tools for hosting and playing interactive online
+courses and MOOCs.
+
+However, if you need to build a complete website with flexible content to aggregate your courses,
+in several languages and from different sources, **you will soon need a CMS**.
+
+At "France Université Numérique", we wanted to build an OpenSource portal with `Python` and
+`Django`. That's why we built `Richie` on top of [DjangoCMS](https://www.django-cms.org), one of
+the best CMS on the market, as a toolbox to easily create full fledged websites with a catalog of
+online courses.
+
+Among the features that `Richie` offers out of the box:
+
+- multi-lingual by default,
+- advanced access rights and moderation,
+- catalog of courses synchronized with one or more `LMS` instances,
+- search engine based on `Elasticsearch` and pre-configured to offer full-text queries,
+  multi-facetting, auto-complete,...
+- flexible custom pages for courses, organizations, categories, teachers, blog posts,
+  programs (and their inter-relations),
+- Extensible with any third-party `DjangoCMS` plugin or any third-party `Django` application.
+
+## Discover Richie
+
+If you're looking for a quick preview of `Richie`, you can take a look and have a tour of
+`Richie` on our dedicated [demo site](https://demo.richie.education).
+
+It is connected back-to-back with a demo of OpenEdX running on
+[OpenEdX Docker](https://github.com/openfun/openedx-docker).
+
+Two users are available for testing:
+
+- admin: `admin@example.com`/`admin`
+- student: `edx@example.com`/`edx`
+
+The database is regularly flushed.
+
+## Getting started
+
+Take a look at our [documentation](https://richie.education/docs/discover) to get started with Richie.
+
+## Contributing
+
+### [Contributing guide](https://richie.education/docs/contributing-guide)
+
+Read our [contributing guide](https://richie.education/docs/contributing-guide) to learn about our development process and get started developing on `Richie`.
+
+### License
+
+This work is released under the MIT License (see [LICENSE](./LICENSE)).

richie-2.25.0b2.dev69/src/frontend/js/api/joanie.ts

@@ -0,0 +1,498 @@
+/**
+ *
+ * Joanie API Interface
+ *
+ * Interface to interact with Joanie Api.
+ *
+ * ⚠︎ You should not import this API interface directly from a component,
+ *    instead you should use the `useJoanieApi` Hook.
+ *
+ */
+import queryString from 'query-string';
+import type * as Joanie from 'types/Joanie';
+import { AuthenticationApi } from 'api/authentication';
+import context from 'utils/context';
+import { HttpError, HttpStatusCode } from 'utils/errors/HttpError';
+import { JOANIE_API_VERSION } from 'settings';
+import { ResourcesQuery } from 'hooks/useResources';
+import { ObjectHelper } from 'utils/ObjectHelper';
+import { Maybe } from 'types/utils';
+
+interface CheckStatusOptions {
+  fallbackValue: any;
+  ignoredErrorStatus: (number | HttpStatusCode)[];
+}
+
+export async function getFileFromResponse(response: Response): Promise<File> {
+  const filenameRegex = /filename="(.*)";/;
+  const dispositionHeader = response.headers.get('Content-Disposition');
+  const matches = dispositionHeader?.match(filenameRegex);
+
+  return new File([await response.blob()], matches ? matches[1] : '');
+}
+
+export function getResponseBody(response: Response) {
+  if (response.headers.get('Content-Type') === 'application/json') {
+    return response.json();
+  }
+  const fileType = ['application/pdf', 'application/zip'];
+  if (fileType.includes(response.headers.get('Content-Type') || '')) {
+    return new Promise((resolve) => resolve(response));
+  }
+  return response.text();
+}
+
+/*
+  A util to manage Joanie API responses.
+  It parses properly the response according to its `Content-Type`
+  otherwise it throws an `HttpError`.
+
+  `options` arguments accept an array of ignoredErrorStatus. If the response
+  fails with one of this status code, the `fallbackValue` will return and no error will
+  be raised.
+*/
+export function checkStatus(
+  response: Response,
+  options: CheckStatusOptions = { fallbackValue: null, ignoredErrorStatus: [] },
+): Promise<any> {
+  if (response.ok) {
+    return getResponseBody(response);
+  }
+
+  if (options.ignoredErrorStatus.includes(response.status)) {
+    return Promise.resolve(options.fallbackValue);
+  }
+
+  throw new HttpError(response.status, response.statusText);
+}
+
+/*
+  Generate default headers used for most of Joanie requests. It defined `Content-Type`
+  to `application/json` and the `Accept-Language` to the active language.
+*/
+function getDefaultHeaders(): Record<string, string> {
+  const $html = document.querySelector('html');
+  const language = $html?.getAttribute('lang') || 'en-US';
+
+  return {
+    'Content-Type': 'application/json',
+    'Accept-Language': language,
+  };
+}
+
+/*
+  Retrieve the access token from `AuthenticationApi` interface then bind it to
+  the request through the `Authorization` header.
+*/
+function fetchWithJWT(routes: RequestInfo, options: RequestInit = {}) {
+  const headers = (options.headers as Record<string, string>) || getDefaultHeaders();
+  try {
+    const accessToken = AuthenticationApi!.accessToken!();
+    if (accessToken) {
+      // eslint-disable-next-line @typescript-eslint/dot-notation
+      headers['Authorization'] = `Bearer ${accessToken}`;
+    }
+  } catch (error) {
+    throw new Error(
+      `Joanie requires JWT Token to fetch data, but the configured authentication
+      api does not contains a method \`accessToken\` to retrieve this information.`,
+    );
+  }
+
+  options.headers = headers;
+  return fetch(routes, options);
+}
+
+/**
+ * Build Joanie API Routes interface.
+ */
+export const getAPIEndpoint = () => {
+  const endpoint = context?.joanie_backend?.endpoint;
+  const version = JOANIE_API_VERSION;
+  if (!endpoint) {
+    throw new Error('[JOANIE] - Joanie API endpoint is not defined.');
+  }
+
+  return `${endpoint}/api/${version}`;
+};
+
+export const getRoutes = () => {
+  const baseUrl = getAPIEndpoint();
+
+  return {
+    user: {
+      me: {
+        get: `${baseUrl}/users/me/`,
+      },
+      creditCards: {
+        get: `${baseUrl}/credit-cards/:id/`,
+        create: `${baseUrl}/credit-cards/`,
+        update: `${baseUrl}/credit-cards/:id/`,
+        delete: `${baseUrl}/credit-cards/:id/`,
+      },
+      addresses: {
+        get: `${baseUrl}/addresses/:id/`,
+        create: `${baseUrl}/addresses/`,
+        update: `${baseUrl}/addresses/:id/`,
+        delete: `${baseUrl}/addresses/:id/`,
+      },
+      orders: {
+        abort: `${baseUrl}/orders/:id/abort/`,
+        create: `${baseUrl}/orders/`,
+        submit: `${baseUrl}/orders/:id/submit/`,
+        get: `${baseUrl}/orders/:id/`,
+        invoice: {
+          download: `${baseUrl}/orders/:id/invoice/`,
+        },
+        submit_for_signature: `${baseUrl}/orders/:id/submit_for_signature/`,
+      },
+      certificates: {
+        download: `${baseUrl}/certificates/:id/download/`,
+        get: `${baseUrl}/certificates/:id/`,
+      },
+      enrollments: {
+        get: `${baseUrl}/enrollments/:id/`,
+        create: `${baseUrl}/enrollments/`,
+        update: `${baseUrl}/enrollments/:id/`,
+      },
+      wish: {
+        get: `${baseUrl}/courses/:course_code/wish/`,
+        create: `${baseUrl}/courses/:course_code/wish/`,
+        delete: `${baseUrl}/courses/:course_code/wish/`,
+      },
+      contracts: {
+        get: `${baseUrl}/contracts/:id/`,
+        download: `${baseUrl}/contracts/:id/download/`,
+        zip_archive: {
+          create: `${baseUrl}/contracts/zip-archive/`,
+          get: `${baseUrl}/contracts/zip-archive/:id/`,
+        },
+      },
+    },
+    organizations: {
+      get: `${baseUrl}/organizations/:id/`,
+      courseProductRelations: {
+        get: `${baseUrl}/organizations/:organization_id/course-product-relations/:id/`,
+      },
+      courses: {
+        get: `${baseUrl}/organizations/:organization_id/courses/:id/`,
+      },
+      contracts: {
+        get: `${baseUrl}/organizations/:organization_id/contracts/:id/`,
+        getSignatureLinks: `${baseUrl}/organizations/:organization_id/contracts-signature-link/`,
+      },
+    },
+    courses: {
+      get: `${baseUrl}/courses/:id/`,
+      courseRuns: {
+        get: `${baseUrl}/courses/:course_id/course-runs/`,
+      },
+      products: {
+        get: `${baseUrl}/courses/:course_id/products/:id/`,
+      },
+    },
+    courseRuns: {
+      get: `${baseUrl}/course-runs/:id/`,
+    },
+    courseProductRelations: {
+      get: `${baseUrl}/course-product-relations/:id/`,
+    },
+    contractDefinitions: {
+      previewTemplate: `${baseUrl}/contract_definitions/:id/preview_template/`,
+    },
+  };
+};
+
+/**
+ * Flag which determines if joanie is enabled.
+ */
+export const isJoanieEnabled = !!context.joanie_backend;
+
+const filterEmptyEntry = ([, value]: [PropertyKey, any]) => {
+  if (value == null) return false; // Value is null/undefined
+  if (value?.length !== undefined && value.length === 0) return false; // Value is an empty array/string
+  return true;
+};
+
+interface ApiFilters extends Record<PropertyKey, any> {
+  queryParameters?: Record<string, any>;
+}
+
+export const buildApiUrl = <Filters extends ApiFilters = ApiFilters>(
+  raw_url: string,
+  { queryParameters = {}, ...urlParams }: Maybe<Filters> = {} as Filters,
+) => {
+  // eslint-disable-next-line compat/compat
+  const url = new URL(raw_url);
+
+  if (!ObjectHelper.isEmpty(urlParams)) {
+    Object.entries(urlParams)
+      .filter(filterEmptyEntry)
+      .forEach(([key, value]) => {
+        if (url.pathname.search(`:${key}`) > 0) {
+          url.pathname = url.pathname.replace(`:${key}`, value);
+        } else {
+          queryParameters[key] = value;
+        }
+      });
+  }
+
+  if (!ObjectHelper.isEmpty(queryParameters)) {
+    Object.entries(queryParameters)
+      .filter(filterEmptyEntry)
+      .forEach(([key, value]) => {
+        if (Array.isArray(value)) {
+          value.forEach((v) => url.searchParams.append(key, v));
+        } else {
+          url.searchParams.append(key, value);
+        }
+      });
+  }
+
+  // Clean up url pathname
+  url.pathname = url.pathname.replaceAll(/:[a-z_]+\//g, '').replaceAll('//', '/');
+
+  return url.toString();
+};
+
+const API = (): Joanie.API => {
+  const ROUTES = getRoutes();
+
+  return {
+    user: {
+      me: {
+        get: async (filters?: ResourcesQuery) => {
+          return fetchWithJWT(buildApiUrl(ROUTES.user.me.get, filters)).then(checkStatus);
+        },
+      },
+      creditCards: {
+        get: async (filters?: ResourcesQuery) => {
+          return fetchWithJWT(buildApiUrl(ROUTES.user.creditCards.get, filters)).then(checkStatus);
+        },
+        create: async (creditCard) =>
+          fetchWithJWT(ROUTES.user.creditCards.create, {
+            method: 'POST',
+            body: JSON.stringify(creditCard),
+          }).then(checkStatus),
+        update: async ({ id, ...creditCard }) => {
+          return fetchWithJWT(ROUTES.user.creditCards.update.replace(':id', id), {
+            method: 'PUT',
+            body: JSON.stringify(creditCard),
+          }).then(checkStatus);
+        },
+        delete: async (id) =>
+          fetchWithJWT(ROUTES.user.creditCards.delete.replace(':id', id), {
+            method: 'DELETE',
+          }).then(checkStatus),
+      },
+      addresses: {
+        get: (id?: string) => {
+          return fetchWithJWT(buildApiUrl(ROUTES.user.addresses.get, { id })).then(checkStatus);
+        },
+        create: async (payload) =>
+          fetchWithJWT(ROUTES.user.addresses.create, {
+            method: 'POST',
+            body: JSON.stringify(payload),
+          }).then(checkStatus),
+        update: async ({ id, ...address }) =>
+          fetchWithJWT(ROUTES.user.addresses.update.replace(':id', id), {
+            method: 'PUT',
+            body: JSON.stringify(address),
+          }).then(checkStatus),
+        delete: async (id) =>
+          fetchWithJWT(ROUTES.user.addresses.delete.replace(':id', id), {
+            method: 'DELETE',
+          }).then(checkStatus),
+      },
+      orders: {
+        abort: async ({ id, payment_id }) => {
+          fetchWithJWT(ROUTES.user.orders.abort.replace(':id', id), {
+            method: 'POST',
+            body: payment_id ? JSON.stringify({ payment_id }) : undefined,
+          }).then(checkStatus);
+        },
+        create: async (payload) =>
+          fetchWithJWT(ROUTES.user.orders.create, {
+            method: 'POST',
+            body: JSON.stringify(payload),
+          }).then(checkStatus),
+        submit: async ({ id, ...payload }) =>
+          fetchWithJWT(ROUTES.user.orders.submit.replace(':id', id), {
+            method: 'PATCH',
+            body: JSON.stringify(payload),
+          }).then(checkStatus),
+        get: async (filters) => {
+          return fetchWithJWT(buildApiUrl(ROUTES.user.orders.get, filters)).then(checkStatus);
+        },
+        invoice: {
+          download: async ({ order_id, invoice_reference }) => {
+            let url = ROUTES.user.orders.invoice.download.replace(':id', order_id);
+            url += `?${queryString.stringify({ reference: invoice_reference })}`;
+
+            return fetchWithJWT(url).then(checkStatus).then(getFileFromResponse);
+          },
+        },
+        submit_for_signature: async (id) =>
+          fetchWithJWT(ROUTES.user.orders.submit_for_signature.replace(':id', id), {
+            method: 'POST',
+          }).then(checkStatus),
+      },
+      enrollments: {
+        create: async (payload) =>
+          fetchWithJWT(ROUTES.user.enrollments.create, {
+            method: 'POST',
+            body: JSON.stringify(payload),
+          }).then(checkStatus),
+        get: async (filters) => {
+          return fetchWithJWT(buildApiUrl(ROUTES.user.enrollments.get, filters)).then(checkStatus);
+        },
+        update: async ({ id, ...payload }) =>
+          fetchWithJWT(ROUTES.user.enrollments.update.replace(':id', id), {
+            method: 'PUT', // MARK or PATCH ?
+            body: JSON.stringify(payload),
+          }).then(checkStatus),
+      },
+      certificates: {
+        download: async (id: string): Promise<File> =>
+          fetchWithJWT(ROUTES.user.certificates.download.replace(':id', id))
+            .then(checkStatus)
+            .then(getFileFromResponse),
+        get: async (filters) => {
+          return fetchWithJWT(buildApiUrl(ROUTES.user.certificates.get, filters)).then(checkStatus);
+        },
+      },
+      wish: {
+        get: async (filters) => {
+          const { id = '', ...parsedFilters } = filters || {};
+          let url: string;
+          if (id) url = ROUTES.user.wish.get.replace(':course_code', id);
+          else url = ROUTES.user.wish.get.replace(':course_code/', '');
+          return fetchWithJWT(buildApiUrl(url, parsedFilters), {
+            method: 'GET',
+          }).then(checkStatus);
+        },
+        create: async (id) => {
+          return fetchWithJWT(ROUTES.user.wish.create.replace(':course_code', id), {
+            method: 'POST',
+          }).then(checkStatus);
+        },
+        delete: async (id) => {
+          return fetchWithJWT(ROUTES.user.wish.delete.replace(':course_code', id), {
+            method: 'DELETE',
+          }).then(checkStatus);
+        },
+      },
+      contracts: {
+        get: async ({ contract_ids, ...filters } = {}) => {
+          const endpointFilters = { ...filters, queryParameters: { id: contract_ids } };
+          return fetchWithJWT(buildApiUrl(ROUTES.user.contracts.get, endpointFilters), {
+            method: 'GET',
+          }).then(checkStatus);
+        },
+        download(id: string): Promise<any> {
+          return fetchWithJWT(ROUTES.user.contracts.download.replace(':id', id), {
+            method: 'GET',
+          })
+            .then(checkStatus)
+            .then(getFileFromResponse);
+        },
+        zip_archive: {
+          check: async (id) => {
+            return fetchWithJWT(ROUTES.user.contracts.zip_archive.get.replace(':id', id), {
+              method: 'OPTIONS',
+            });
+          },
+          create: async (payload) => {
+            return fetchWithJWT(ROUTES.user.contracts.zip_archive.create, {
+              method: 'POST',
+              body: JSON.stringify(payload),
+            }).then(checkStatus);
+          },
+          get: async (id) => {
+            return fetchWithJWT(ROUTES.user.contracts.zip_archive.get.replace(':id', id), {
+              method: 'GET',
+            })
+              .then(checkStatus)
+              .then(getFileFromResponse);
+          },
+        },
+      },
+    },
+    organizations: {
+      get: async (filters) => {
+        return fetchWithJWT(buildApiUrl(ROUTES.organizations.get, filters), {
+          method: 'GET',
+        }).then(checkStatus);
+      },
+      contracts: {
+        get: async ({ contract_ids, ...filters } = {}) => {
+          const endpointFilters = { ...filters, queryParameters: { id: contract_ids } };
+          return fetchWithJWT(buildApiUrl(ROUTES.organizations.contracts.get, endpointFilters), {
+            method: 'GET',
+          }).then(checkStatus);
+        },
+        getSignatureLinks: async (filters) => {
+          return fetchWithJWT(
+            buildApiUrl(ROUTES.organizations.contracts.getSignatureLinks, filters),
+            {
+              method: 'GET',
+            },
+          ).then(checkStatus);
+        },
+      },
+    },
+    courses: {
+      get: (filters?: Joanie.CourseQueryFilters) => {
+        return fetchWithJWT(
+          filters?.organization_id
+            ? buildApiUrl(ROUTES.organizations.courses.get, filters)
+            : buildApiUrl(ROUTES.courses.get, filters),
+        ).then(checkStatus);
+      },
+      products: {
+        get: async (filters?: Joanie.CourseProductQueryFilters) => {
+          if (!filters) {
+            throw new Error(
+              'A course code and a product id are required to fetch a course product',
+            );
+          } else if (!filters.course_id) {
+            throw new Error('A course code is required to fetch a course product');
+          } else if (!filters.id) {
+            throw new Error('A product id is required to fetch a course product');
+          }
+
+          return fetchWithJWT(buildApiUrl(ROUTES.courses.products.get, filters)).then(checkStatus);
+        },
+      },
+    },
+    courseRuns: {
+      get: (filters: Joanie.CourseRunFilters) => {
+        return fetchWithJWT(
+          filters.course_id
+            ? buildApiUrl(ROUTES.courses.courseRuns.get, filters)
+            : buildApiUrl(ROUTES.courseRuns.get, filters),
+        ).then(checkStatus);
+      },
+    },
+    courseProductRelations: {
+      get: (filters?: Joanie.CourseProductRelationQueryFilters) => {
+        return fetchWithJWT(
+          filters?.organization_id
+            ? buildApiUrl(ROUTES.organizations.courseProductRelations.get, filters)
+            : buildApiUrl(ROUTES.courseProductRelations.get, filters),
+        ).then(checkStatus);
+      },
+    },
+    contractDefinitions: {
+      previewTemplate(id: string): Promise<File> {
+        return fetchWithJWT(
+          buildApiUrl(ROUTES.contractDefinitions.previewTemplate, {
+            id,
+          }),
+        ).then(checkStatus);
+      },
+    },
+  };
+};
+
+export default API;