@enbbox/api 1.0.0 → 1.0.1

package/docs/SubscribersApi.md

@@ -0,0 +1,887 @@
+# SubscribersApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**bulkCreate**](#bulkcreate) | **POST** /v1/subscribers/bulk/ | POST /v1/subscribers/bulk — create multiple subscribers at once|
+|[**bulkUpdatePreferences**](#bulkupdatepreferences) | **PATCH** /v1/subscribers/{id}/preferences/bulk/ | PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once|
+|[**createSubscriber**](#createsubscriber) | **POST** /v1/subscribers/ | POST /v1/subscribers|
+|[**deleteCredentials**](#deletecredentials) | **DELETE** /v1/subscribers/{id}/credentials/{provider_id}/ | DELETE /v1/subscribers/:id/credentials/:provider_id — remove creds for a provider|
+|[**deleteSubscriber**](#deletesubscriber) | **DELETE** /v1/subscribers/{id}/ | DELETE /v1/subscribers/:subscriber_id|
+|[**getSubscriber**](#getsubscriber) | **GET** /v1/subscribers/{id}/ | GET /v1/subscribers/:subscriber_id|
+|[**listSubscriberSubscriptions**](#listsubscribersubscriptions) | **GET** /v1/subscribers/{id}/subscriptions/ | GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber|
+|[**listSubscribers**](#listsubscribers) | **GET** /v1/subscribers/ | GET /v1/subscribers|
+|[**markAllMessages**](#markallmessages) | **POST** /v1/subscribers/{id}/messages/mark-all/ | POST /v1/subscribers/:id/messages/mark-all — mark all messages|
+|[**markMessages**](#markmessages) | **POST** /v1/subscribers/{id}/messages/mark-as/ | POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen|
+|[**setCredentials**](#setcredentials) | **PUT** /v1/subscribers/{id}/credentials/ | PUT /v1/subscribers/:id/credentials — replace all creds for a provider|
+|[**subscriberFeed**](#subscriberfeed) | **GET** /v1/subscribers/{id}/notifications/feed/ | GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list|
+|[**unseenCount**](#unseencount) | **GET** /v1/subscribers/{id}/notifications/unseen/ | GET /v1/subscribers/:id/notifications/unseen — unseen count|
+|[**updateOnlineStatus**](#updateonlinestatus) | **PATCH** /v1/subscribers/{id}/online-status/ | PATCH /v1/subscribers/:id/online-status — set online/offline|
+|[**updateSubscriber**](#updatesubscriber) | **PATCH** /v1/subscribers/{id}/ | PATCH /v1/subscribers/:subscriber_id|
+|[**upsertCredentials**](#upsertcredentials) | **PATCH** /v1/subscribers/{id}/credentials/ | PATCH /v1/subscribers/:id/credentials — upsert/merge creds for a provider|
+
+# **bulkCreate**
+> BulkResult bulkCreate(bulkCreateSubscribers)
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration,
+    BulkCreateSubscribers
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let bulkCreateSubscribers: BulkCreateSubscribers; //
+
+const { status, data } = await apiInstance.bulkCreate(
+    bulkCreateSubscribers
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bulkCreateSubscribers** | **BulkCreateSubscribers**|  | |
+
+
+### Return type
+
+**BulkResult**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **bulkUpdatePreferences**
+> bulkUpdatePreferences(bulkPreferences)
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration,
+    BulkPreferences
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let bulkPreferences: BulkPreferences; //
+
+const { status, data } = await apiInstance.bulkUpdatePreferences(
+    id,
+    bulkPreferences
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bulkPreferences** | **BulkPreferences**|  | |
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Updated |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **createSubscriber**
+> SubscriberRecord createSubscriber(createSubscriber)
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration,
+    CreateSubscriber
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let createSubscriber: CreateSubscriber; //
+
+const { status, data } = await apiInstance.createSubscriber(
+    createSubscriber
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createSubscriber** | **CreateSubscriber**|  | |
+
+
+### Return type
+
+**SubscriberRecord**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** |  |  -  |
+|**409** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteCredentials**
+> deleteCredentials()
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let providerId: string; //Provider ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteCredentials(
+    id,
+    providerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+| **providerId** | [**string**] | Provider ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Deleted |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteSubscriber**
+> deleteSubscriber()
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteSubscriber(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Deleted |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getSubscriber**
+> SubscriberRecord getSubscriber()
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+
+const { status, data } = await apiInstance.getSubscriber(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**SubscriberRecord**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**404** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listSubscriberSubscriptions**
+> Array<TopicSubscription> listSubscriberSubscriptions()
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+
+const { status, data } = await apiInstance.listSubscriberSubscriptions(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**Array<TopicSubscription>**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listSubscribers**
+> PaginatedSubscriberRecord listSubscribers()
+
+Lists subscribers for the current project. When the optional `q` query parameter is provided, the list is powered by Typesense full-text search (searching across email, name, phone, subscriber_id). Without `q`, a standard paginated listing from the primary store is returned.
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let limit: number; //Maximum number of items to return (1–100, default 10). (optional) (default to undefined)
+let offset: number; //Number of items to skip (default 0). (optional) (default to undefined)
+let q: string; //Optional full-text search query (e.g., an email, name, or phone number). When present, search is powered by Typesense. (optional) (default to undefined)
+let filterBy: string; //Optional filter expression for narrowing results. Example: `is_online:=true` or `locale:=en-US`. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listSubscribers(
+    limit,
+    offset,
+    q,
+    filterBy
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Maximum number of items to return (1–100, default 10). | (optional) defaults to undefined|
+| **offset** | [**number**] | Number of items to skip (default 0). | (optional) defaults to undefined|
+| **q** | [**string**] | Optional full-text search query (e.g., an email, name, or phone number). When present, search is powered by Typesense. | (optional) defaults to undefined|
+| **filterBy** | [**string**] | Optional filter expression for narrowing results. Example: &#x60;is_online:&#x3D;true&#x60; or &#x60;locale:&#x3D;en-US&#x60;. | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedSubscriberRecord**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **markAllMessages**
+> MarkResult markAllMessages(markAll)
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration,
+    MarkAll
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let markAll: MarkAll; //
+
+const { status, data } = await apiInstance.markAllMessages(
+    id,
+    markAll
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **markAll** | **MarkAll**|  | |
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**MarkResult**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **markMessages**
+> MarkResult markMessages(markMessages)
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration,
+    MarkMessages
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let markMessages: MarkMessages; //
+
+const { status, data } = await apiInstance.markMessages(
+    id,
+    markMessages
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **markMessages** | **MarkMessages**|  | |
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**MarkResult**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **setCredentials**
+> SubscriberRecord setCredentials(setCredentials)
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration,
+    SetCredentials
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let setCredentials: SetCredentials; //
+
+const { status, data } = await apiInstance.setCredentials(
+    id,
+    setCredentials
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **setCredentials** | **SetCredentials**|  | |
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**SubscriberRecord**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **subscriberFeed**
+> CursorPaginatedFeedItem subscriberFeed()
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let limit: number; // (optional) (default to undefined)
+let after: string; // (optional) (default to undefined)
+let before: string; // (optional) (default to undefined)
+let channel: string; // (optional) (default to undefined)
+let read: boolean; // (optional) (default to undefined)
+let seen: boolean; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.subscriberFeed(
+    id,
+    limit,
+    after,
+    before,
+    channel,
+    read,
+    seen
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+| **after** | [**string**] |  | (optional) defaults to undefined|
+| **before** | [**string**] |  | (optional) defaults to undefined|
+| **channel** | [**string**] |  | (optional) defaults to undefined|
+| **read** | [**boolean**] |  | (optional) defaults to undefined|
+| **seen** | [**boolean**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**CursorPaginatedFeedItem**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **unseenCount**
+> UnseenCount unseenCount()
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+
+const { status, data } = await apiInstance.unseenCount(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**UnseenCount**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateOnlineStatus**
+> SubscriberRecord updateOnlineStatus(onlineStatus)
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration,
+    OnlineStatus
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let onlineStatus: OnlineStatus; //
+
+const { status, data } = await apiInstance.updateOnlineStatus(
+    id,
+    onlineStatus
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **onlineStatus** | **OnlineStatus**|  | |
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**SubscriberRecord**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateSubscriber**
+> SubscriberRecord updateSubscriber(updateSubscriber)
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration,
+    UpdateSubscriber
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let updateSubscriber: UpdateSubscriber; //
+
+const { status, data } = await apiInstance.updateSubscriber(
+    id,
+    updateSubscriber
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateSubscriber** | **UpdateSubscriber**|  | |
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**SubscriberRecord**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**404** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **upsertCredentials**
+> SubscriberRecord upsertCredentials(patchCredentials)
+
+
+### Example
+
+```typescript
+import {
+    SubscribersApi,
+    Configuration,
+    PatchCredentials
+} from '@enbbox/api';
+
+const configuration = new Configuration();
+const apiInstance = new SubscribersApi(configuration);
+
+let id: string; //Subscriber ID (default to undefined)
+let patchCredentials: PatchCredentials; //
+
+const { status, data } = await apiInstance.upsertCredentials(
+    id,
+    patchCredentials
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **patchCredentials** | **PatchCredentials**|  | |
+| **id** | [**string**] | Subscriber ID | defaults to undefined|
+
+
+### Return type
+
+**SubscriberRecord**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+