tuix-subscription-service-client 0.0.1

package/docs/ClientApi.md

@@ -0,0 +1,286 @@
+# ClientApi
+
+All URIs are relative to *http://0.0.0.0:3000/local*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createSubscription**](ClientApi.md#createsubscription) | **POST** /subscriptions | Create a new subscription |
+| [**deleteSubscription**](ClientApi.md#deletesubscription) | **DELETE** /subscriptions/{id} | Delete a subscription |
+| [**getSubscriptions**](ClientApi.md#getsubscriptions) | **GET** /subscriptions | Get all subscriptions |
+| [**sendNewsletter**](ClientApi.md#sendnewsletter) | **POST** /subscriptions/newsletter | Send newsletter to all subscribers |
+
+
+
+## createSubscription
+
+> SubscriptionDTO createSubscription(createSubscriptionDTO)
+
+Create a new subscription
+
+Create a new subscription
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { CreateSubscriptionRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientApi();
+
+  const body = {
+    // CreateSubscriptionDTO | Subscription data
+    createSubscriptionDTO: ...,
+  } satisfies CreateSubscriptionRequest;
+
+  try {
+    const data = await api.createSubscription(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createSubscriptionDTO** | [CreateSubscriptionDTO](CreateSubscriptionDTO.md) | Subscription data | |
+
+### Return type
+
+[**SubscriptionDTO**](SubscriptionDTO.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created subscription |  -  |
+| **400** | Return an error if there is a missing or invalid field |  -  |
+| **401** | Return an error if the user is not authorized |  -  |
+| **409** | Return an error if subscription already exists |  -  |
+| **500** | Return an error if an internal error occurs |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteSubscription
+
+> deleteSubscription(id)
+
+Delete a subscription
+
+Delete a subscription
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { DeleteSubscriptionRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientApi();
+
+  const body = {
+    // string | Subscription ID
+    id: id_example,
+  } satisfies DeleteSubscriptionRequest;
+
+  try {
+    const data = await api.deleteSubscription(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Subscription ID | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Subscription deleted successfully |  -  |
+| **400** | Return an error if there is a missing or invalid field |  -  |
+| **401** | Return an error if the user is not authorized |  -  |
+| **404** | Return an error if subscription not found |  -  |
+| **500** | Return an error if an internal error occurs |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSubscriptions
+
+> Array<SubscriptionDTO> getSubscriptions()
+
+Get all subscriptions
+
+Get all subscriptions
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { GetSubscriptionsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientApi();
+
+  try {
+    const data = await api.getSubscriptions();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<SubscriptionDTO>**](SubscriptionDTO.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of subscriptions |  -  |
+| **400** | Return an error if there is a missing or invalid field |  -  |
+| **401** | Return an error if the user is not authorized |  -  |
+| **500** | Return an error if an internal error occurs |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## sendNewsletter
+
+> SubscriptionsSentResponseDTO sendNewsletter(sendNewsletterDTO)
+
+Send newsletter to all subscribers
+
+Send newsletter to all subscribers
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { SendNewsletterRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new ClientApi();
+
+  const body = {
+    // SendNewsletterDTO | Newsletter data
+    sendNewsletterDTO: ...,
+  } satisfies SendNewsletterRequest;
+
+  try {
+    const data = await api.sendNewsletter(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sendNewsletterDTO** | [SendNewsletterDTO](SendNewsletterDTO.md) | Newsletter data | |
+
+### Return type
+
+[**SubscriptionsSentResponseDTO**](SubscriptionsSentResponseDTO.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Newsletter sent response |  -  |
+| **400** | Return an error if there is a missing or invalid field |  -  |
+| **401** | Return an error if the user is not authorized |  -  |
+| **500** | Return an error if an internal error occurs |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/CreateSubscriptionDTO.md

@@ -0,0 +1,36 @@
+
+# CreateSubscriptionDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`language` | string
+
+## Example
+
+```typescript
+import type { CreateSubscriptionDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": null,
+  "language": null,
+} satisfies CreateSubscriptionDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateSubscriptionDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ErrorDTO.md

@@ -0,0 +1,34 @@
+
+# ErrorDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+
+## Example
+
+```typescript
+import type { ErrorDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+} satisfies ErrorDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ErrorDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SendNewsletterDTO.md

@@ -0,0 +1,34 @@
+
+# SendNewsletterDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`templateId` | string
+
+## Example
+
+```typescript
+import type { SendNewsletterDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "templateId": null,
+} satisfies SendNewsletterDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SendNewsletterDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SubscriptionDTO.md

@@ -0,0 +1,42 @@
+
+# SubscriptionDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`email` | string
+`id` | string
+`language` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { SubscriptionDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "email": null,
+  "id": null,
+  "language": null,
+  "updatedAt": null,
+} satisfies SubscriptionDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SubscriptionDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SubscriptionSentDTO.md

@@ -0,0 +1,36 @@
+
+# SubscriptionSentDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`emailSent` | boolean
+`subscription` | [SubscriptionDTO](SubscriptionDTO.md)
+
+## Example
+
+```typescript
+import type { SubscriptionSentDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "emailSent": null,
+  "subscription": null,
+} satisfies SubscriptionSentDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SubscriptionSentDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SubscriptionsSentResponseDTO.md

@@ -0,0 +1,34 @@
+
+# SubscriptionsSentResponseDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`subscriptionsProcessed` | [Array<SubscriptionSentDTO>](SubscriptionSentDTO.md)
+
+## Example
+
+```typescript
+import type { SubscriptionsSentResponseDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "subscriptionsProcessed": null,
+} satisfies SubscriptionsSentResponseDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SubscriptionsSentResponseDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/index.js

@@ -0,0 +1,22 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./runtime"), exports);
+__exportStar(require("./apis/index"), exports);
+__exportStar(require("./models/index"), exports);
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oBAAoB;AACpB,oBAAoB;AACpB,4CAA0B;AAC1B,+CAA6B;AAC7B,iDAA+B"}

package/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/models/CreateSubscriptionDTO.js

@@ -0,0 +1,51 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Tuix Subscriptions Service
+ * Service to manage Tuix Subscriptions
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCreateSubscriptionDTO = instanceOfCreateSubscriptionDTO;
+exports.CreateSubscriptionDTOFromJSON = CreateSubscriptionDTOFromJSON;
+exports.CreateSubscriptionDTOFromJSONTyped = CreateSubscriptionDTOFromJSONTyped;
+exports.CreateSubscriptionDTOToJSON = CreateSubscriptionDTOToJSON;
+exports.CreateSubscriptionDTOToJSONTyped = CreateSubscriptionDTOToJSONTyped;
+/**
+ * Check if a given object implements the CreateSubscriptionDTO interface.
+ */
+function instanceOfCreateSubscriptionDTO(value) {
+    return true;
+}
+function CreateSubscriptionDTOFromJSON(json) {
+    return CreateSubscriptionDTOFromJSONTyped(json, false);
+}
+function CreateSubscriptionDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'email': json['email'] == null ? undefined : json['email'],
+        'language': json['language'] == null ? undefined : json['language'],
+    };
+}
+function CreateSubscriptionDTOToJSON(json) {
+    return CreateSubscriptionDTOToJSONTyped(json, false);
+}
+function CreateSubscriptionDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'email': value['email'],
+        'language': value['language'],
+    };
+}
+//# sourceMappingURL=CreateSubscriptionDTO.js.map

package/models/CreateSubscriptionDTO.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreateSubscriptionDTO.js","sourceRoot":"","sources":["CreateSubscriptionDTO.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;AA0BH,0EAEC;AAED,sEAEC;AAED,gFASC;AAED,kEAEC;AAED,4EAUC;AApCD;;GAEG;AACH,SAAgB,+BAA+B,CAAC,KAAa;IACzD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAgB,6BAA6B,CAAC,IAAS;IACnD,OAAO,kCAAkC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAAgB,kCAAkC,CAAC,IAAS,EAAE,mBAA4B;IACtF,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1D,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;KACtE,CAAC;AACN,CAAC;AAED,SAAgB,2BAA2B,CAAC,IAAS;IACjD,OAAO,gCAAgC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACzD,CAAC;AAED,SAAgB,gCAAgC,CAAC,KAAoC,EAAE,sBAA+B,KAAK;IACvH,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;QACvB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;KAChC,CAAC;AACN,CAAC"}

package/models/CreateSubscriptionDTO.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Tuix Subscriptions Service
+ * Service to manage Tuix Subscriptions
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateSubscriptionDTO
+ */
+export interface CreateSubscriptionDTO {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubscriptionDTO
+     */
+    email?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateSubscriptionDTO
+     */
+    language?: string;
+}
+
+/**
+ * Check if a given object implements the CreateSubscriptionDTO interface.
+ */
+export function instanceOfCreateSubscriptionDTO(value: object): value is CreateSubscriptionDTO {
+    return true;
+}
+
+export function CreateSubscriptionDTOFromJSON(json: any): CreateSubscriptionDTO {
+    return CreateSubscriptionDTOFromJSONTyped(json, false);
+}
+
+export function CreateSubscriptionDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSubscriptionDTO {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'email': json['email'] == null ? undefined : json['email'],
+        'language': json['language'] == null ? undefined : json['language'],
+    };
+}
+
+export function CreateSubscriptionDTOToJSON(json: any): CreateSubscriptionDTO {
+    return CreateSubscriptionDTOToJSONTyped(json, false);
+}
+
+export function CreateSubscriptionDTOToJSONTyped(value?: CreateSubscriptionDTO | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'email': value['email'],
+        'language': value['language'],
+    };
+}
+