@sinch/sms 1.2.1 → 1.4.0

package/README.md

@@ -143,6 +143,22 @@ const response_1: Sms.SendSMSResponse = await smsServiceWithProjectId.batches.se
 const response_2: Sms.SendSMSResponse = await smsServiceWithServicePlanId.batches.send(requestData);
 ```
 
+## Other parameters
+
+`smsHostname`: You can override the default hostname used to send requests to the SMS API by providing the `smsHostname` parameter in the `SinchClientParameters` object. By default, the hostname is built based on the selected region and authentication method.
+ - For OAuth2 authentication, the default hostname is `zt.{region}.sms.api.sinch.com`
+ - For API Token authentication, the default hostname is `{region}.sms.api.sinch.com`
+
+```typescript
+const credentials: UnifiedCredentials = {
+  projectId: 'PROJECT_ID',
+  keyId: 'KEY_ID',
+  keySecret: 'KEY_SECRET',
+  smsHostname: 'my.custom.domain.com',
+};
+const smsService = new SmsService(credentials);
+```
+
 ## Promises
 
 All the methods that interact with the Sinch APIs use Promises. You can use `await` in an `async` method to wait for the response, or you can resolve them yourself with `then()` / `catch()`.

package/dist/models/v1/add-keyword/add-keyword.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Keyword to be sent in MO to add MSISDN to a group
+ */
+export interface AddKeyword {
+    /** Opt-in keyword like "JOIN" if `auto_update.to` is dedicated long/short number or unique brand keyword like "Sinch" if it is a shared short code. */
+    first_word: string;
+    /** Opt-in keyword like "JOIN" if `auto_update.to` is shared short code. */
+    second_word?: string;
+}
+/** Validation regex for first_word */
+export declare const firstWordPattern: RegExp;
+/** Validation regex for second_word */
+export declare const secondWordPattern: RegExp;

package/dist/models/v1/{group-object-auto-update-remove/group-object-auto-update-remove.js → add-keyword/add-keyword.js}

@@ -5,4 +5,4 @@ exports.secondWordPattern = exports.firstWordPattern = void 0;
 exports.firstWordPattern = /^\w+$/;
 /** Validation regex for second_word */
 exports.secondWordPattern = /^\w+$/;
-//# sourceMappingURL=group-object-auto-update-remove.js.map
+//# sourceMappingURL=add-keyword.js.map

package/dist/models/v1/add-keyword/add-keyword.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-keyword.js","sourceRoot":"","sources":["../../../../src/models/v1/add-keyword/add-keyword.ts"],"names":[],"mappings":";;;AAUA,sCAAsC;AACzB,QAAA,gBAAgB,GAAG,OAAO,CAAC;AAExC,uCAAuC;AAC1B,QAAA,iBAAiB,GAAG,OAAO,CAAC"}

package/dist/models/v1/add-keyword/index.d.ts

@@ -0,0 +1 @@
+export type { AddKeyword } from './add-keyword';

package/dist/models/v1/add-keyword/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/add-keyword/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/api-mo-message/api-mo-message.d.ts

@@ -2,20 +2,18 @@
  * The page of inbounds matching the given filters.
  */
 export interface ApiMoMessage {
-    body?: string;
     /** If this inbound message is in response to a previously sent message that contained a client reference, then this field contains *that* client reference.   Utilizing this feature requires additional setup on your account. Contact your <a href=\"https://dashboard.sinch.com/settings/account-details\" target=\"_blank\">account manager</a> to enable this feature. */
     client_reference?: string;
-    /** The phone number that sent the message. <a href=\"https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628\" target=\"_blank\">More info</a> */
+    /** The phone number that sent the message. [More info](https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628) */
     from: string;
     /** The ID of this inbound message. */
     id: string;
-    /** The MCC/MNC of the sender\'s operator if known. */
+    /** The MCC/MNC of the sender's operator if known. */
     operator_id?: string;
-    /** When the system received the message.   Formatted as <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO-8601</a>: `YYYY-MM-DDThh:mm:ss.SSSZ`. */
+    /** When the system received the message.   Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`. */
     received_at: Date;
-    /** When the message left the originating device. Only available if provided by operator.  Formatted as <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO-8601</a>: `YYYY-MM-DDThh:mm:ss.SSSZ`. */
+    /** When the message left the originating device. Only available if provided by operator.  Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`. */
     sent_at?: Date;
     /** The Sinch phone number or short code to which the message was sent. */
     to: string;
-    type: string;
 }

package/dist/models/v1/api-update-binary-mt-message/api-update-binary-mt-message.d.ts

@@ -2,7 +2,7 @@ import { DeliveryReportEnum } from '../enums';
 export interface ApiUpdateBinaryMtMessage {
     /** Sender number. Must be valid phone number, short code or alphanumeric. */
     from?: string;
-    /** SMS in binary format */
+    /** SMS in [binary](https://community.sinch.com/t5/Glossary/Binary-SMS/ta-p/7470) format. */
     type?: 'mt_binary';
     /** List of phone numbers and group IDs to add to the batch. */
     to_add?: string[];
@@ -10,14 +10,23 @@ export interface ApiUpdateBinaryMtMessage {
     to_remove?: string[];
     /** Request delivery report callback.     Note that delivery reports can be fetched from the API regardless of this setting.  */
     delivery_report?: DeliveryReportEnum;
-    /** If set, in the future the message will be delayed until `send_at` occurs. Formatted as <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO-8601</a>: `YYYY-MM-DDThh:mm:ss.SSSZ`.  Constraints: Must be before expire_at. If set in the past, messages will be sent immediately.  */
+    /** If set, in the future the message will be delayed until `send_at` occurs. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.  Constraints: Must be before expire_at. If set in the past, messages will be sent immediately.  */
     send_at?: Date;
-    /** If set, the system will stop trying to deliver the message at this point.  Constraints: Must be after `send_at`  Default: 3 days after `send_at`  */
+    /** If set, the system will stop trying to deliver the message at this point.
+     * Must be after `send_at`. Default and max is 3 days after `send_at`. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601). For example: `YYYY-MM-DDThh:mm:ss.SSSZ`. */
     expire_at?: Date;
     /** Override the default callback URL for this batch.  Constraints: Must be valid URL.  */
     callback_url?: string;
+    /** The client identifier of a batch message. If set, the identifier will be added in the delivery report/callback of this batch. */
+    client_reference?: string;
+    /** If set to true then [feedback](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
+    feedback_enabled?: boolean;
     /** The message content Base64 encoded.     Max 140 bytes together with udh. */
     body?: string;
     /** The UDH header of a binary message HEX encoded. Max 140 bytes together with body. */
     udh?: string;
+    /** The type of number for the sender number. Use to override the automatic detection. */
+    from_ton?: number;
+    /** Number Plan Indicator for the sender number. Use to override the automatic detection. */
+    from_npi?: number;
 }

package/dist/models/v1/api-update-mms-mt-message/api-update-mms-mt-message.d.ts

@@ -12,16 +12,21 @@ export interface ApiUpdateMmsMtMessage {
     to_remove?: string[];
     /** Request delivery report callback.     Note that delivery reports can be fetched from the API regardless of this setting.  */
     delivery_report?: DeliveryReportEnum;
-    /** If set, in the future the message will be delayed until `send_at` occurs. Formatted as <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO-8601</a>: `YYYY-MM-DDThh:mm:ss.SSSZ`.  Constraints: Must be before expire_at. If set in the past, messages will be sent immediately.  */
+    /** If set, in the future the message will be delayed until `send_at` occurs. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.  Constraints: Must be before expire_at. If set in the past, messages will be sent immediately.  */
     send_at?: Date;
-    /** If set, the system will stop trying to deliver the message at this point.  Constraints: Must be after `send_at`  Default: 3 days after `send_at`  */
+    /** If set, the system will stop trying to deliver the message at this point.
+     * Must be after `send_at`. Default and max is 3 days after `send_at`. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.  */
     expire_at?: Date;
     /** Override the default callback URL for this batch.  Constraints: Must be valid URL.  */
     callback_url?: string;
+    /** The client identifier of a batch message. If set, the identifier will be added in the delivery report/callback of this batch */
+    client_reference?: string;
+    /** If set to `true`, then [feedback](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
+    feedback_enabled?: boolean;
     /** @see MediaBody */
     body?: MediaBody;
     /** @see ParameterGroup */
     parameters?: ParameterGroup;
-    /** Whether or not you want the media included in your message to be checked against [Sinch MMS channel best practices](/docs/mms/bestpractices/). If set to true, your message will be rejected if it doesn\'t conform to the listed recommendations, otherwise no validation will be performed.  */
+    /** Whether or not you want the media included in your message to be checked against [Sinch MMS channel best practices](https://developers.sinch.com/docs/mms/bestpractices/). If set to true, your message will be rejected if it doesn't conform to the listed recommendations, otherwise no validation will be performed.  */
     strict_validation?: boolean;
 }

package/dist/models/v1/api-update-text-mt-message/api-update-text-mt-message.d.ts

@@ -11,14 +11,29 @@ export interface ApiUpdateTextMtMessage {
     to_remove?: string[];
     /** Request delivery report callback.     Note that delivery reports can be fetched from the API regardless of this setting.  */
     delivery_report?: DeliveryReportEnum;
-    /** If set, in the future the message will be delayed until `send_at` occurs. Formatted as <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO-8601</a>: `YYYY-MM-DDThh:mm:ss.SSSZ`.  Constraints: Must be before expire_at. If set in the past, messages will be sent immediately.  */
+    /** If set, in the future the message will be delayed until `send_at` occurs. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.  Constraints: Must be before expire_at. If set in the past, messages will be sent immediately.  */
     send_at?: Date;
-    /** If set, the system will stop trying to deliver the message at this point.  Constraints: Must be after `send_at`  Default: 3 days after `send_at`  */
+    /** If set, the system will stop trying to deliver the message at this point.
+     * Must be after `send_at`. Default and max is 3 days after `send_at`. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`. */
     expire_at?: Date;
     /** Override the default callback URL for this batch.  Constraints: Must be valid URL.  */
     callback_url?: string;
+    /** The client identifier of a batch message. If set, the identifier will be added in the delivery report/callback of this batch */
+    client_reference?: string;
+    /** If set to `true`, then [feedback](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
+    feedback_enabled?: boolean;
     /** @see ParameterGroup */
     parameters?: ParameterGroup;
     /** The message content */
     body?: string;
+    /** The type of number for the sender number. Use to override the automatic detection. */
+    from_ton?: number;
+    /** Number Plan Indicator for the sender number. Use to override the automatic detection. */
+    from_npi?: number;
+    /** Message will be dispatched only if it is not split to more parts than Max Number of Message Parts */
+    max_number_of_message_parts?: number;
+    /** If set to `true` the message will be shortened when exceeding one part. */
+    truncate_concat?: boolean;
+    /** Shows message on screen without user interaction while not saving the message to the inbox. */
+    flash_message?: boolean;
 }

package/dist/models/v1/binary-request/binary-request.d.ts

@@ -8,7 +8,7 @@ export interface BinaryRequest {
     body: string;
     /** The UDH header of a binary message HEX encoded. Max 140 bytes including the `body`. */
     udh: string;
-    /** SMS in <a href=\"https://community.sinch.com/t5/Glossary/Binary-SMS/ta-p/7470\" target=\"_blank\">binary</a> format. */
+    /** SMS in [binary](https://community.sinch.com/t5/Glossary/Binary-SMS/ta-p/7470) format. */
     type?: 'mt_binary';
     /** Request delivery report callback. Note that delivery reports can be fetched from the API regardless of this setting.  */
     delivery_report?: DeliveryReportEnum;
@@ -22,14 +22,8 @@ export interface BinaryRequest {
     callback_url?: string;
     /** The client identifier of a batch message. If set, the identifier will be added in the delivery report/callback of this batch. */
     client_reference?: string;
-    /** If set to true then [feedback](/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
+    /** If set to true then [feedback](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
     feedback_enabled?: boolean;
-    /** Shows message on screen without user interaction while not saving the message to the inbox. */
-    flash_message?: boolean;
-    /** If set to `true`, the message will be shortened when exceeding one part. */
-    truncate_concat?: boolean;
-    /** Message will be dispatched only if it is not split to more parts than the maximum number of message parts. */
-    max_number_of_message_parts?: number;
     /** The type of number for the sender number. Use to override the automatic detection. */
     from_ton?: number;
     /** Number Plan Indicator for the sender number. Use to override the automatic detection. */

package/dist/models/v1/binary-response/binary-response.d.ts

@@ -10,9 +10,9 @@ export interface BinaryResponse {
     canceled?: boolean;
     /** The message content provided. Base64 encoded. */
     body?: string;
-    /** The <a href=\"https://community.sinch.com/t5/Glossary/UDH-User-Data-Header/ta-p/7776\" target=\"_blank\">UDH</a> header of a binary message HEX encoded. Max 140 bytes including the `body`. */
+    /** The [UDH](https://community.sinch.com/t5/Glossary/UDH-User-Data-Header/ta-p/7776) header of a binary message HEX encoded. Max 140 bytes including the `body`. */
     udh?: string;
-    /** SMS in <a href=\"https://community.sinch.com/t5/Glossary/Binary-SMS/ta-p/7470\" target=\"_blank\">binary</a> format. */
+    /** SMS in [binary](https://community.sinch.com/t5/Glossary/Binary-SMS/ta-p/7470) format. */
     type?: 'mt_binary';
     /** Timestamp for when batch was created.   Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601). For example: `YYYY-MM-DDThh:mm:ss.SSSZ`. */
     created_at?: Date;
@@ -22,20 +22,15 @@ export interface BinaryResponse {
     delivery_report?: DeliveryReportEnum;
     /** If set, the date and time the message should be delivered. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601). For example: `YYYY-MM-DDThh:mm:ss.SSSZ`. */
     send_at?: Date;
-    /** If set, the date and time the message will expire. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601). For example: `YYYY-MM-DDThh:mm:ss.SSSZ`. */
+    /** If set, the system will stop trying to deliver the message at this point.
+     * Must be after `send_at`. Default and max is 3 days after `send_at`. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`. */
     expire_at?: Date;
     /** The callback URL provided in the request. */
     callback_url?: string;
     /** The string input to identify this batch message. If set, the identifier will be added in the delivery report/callback of this batch. */
     client_reference?: string;
-    /** If set to true, then [feedback](/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
+    /** If set to true then [feedback](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
     feedback_enabled?: boolean;
-    /** If sent as a flash message, displays `true`. */
-    flash_message?: boolean;
-    /** If set to `true`, the message was shortened when exceeding one part. */
-    truncate_concat?: boolean;
-    /** Displays the number of message parts set in the request. */
-    max_number_of_message_parts?: number;
     /** The type of number for the sender number. */
     from_ton?: number;
     /** Number Plan Indicator for the sender number. */

package/dist/models/v1/create-group-request/create-group-request.d.ts

@@ -1,11 +1,11 @@
-import { GroupObjectAutoUpdate } from '../group-object-auto-update';
+import { GroupAutoUpdate } from '../group-auto-update';
 export interface CreateGroupRequest {
     /** Name of the group */
     name?: string;
-    /** \"Initial list of phone numbers in <a href=\"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537\" target=\"_blank\">E.164</a> format <a href=\"https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628\" target=\"_blank\">MSISDNs</a> for the group.\" */
+    /** Initial list of phone numbers in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format [MSISDNs](https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628) for the group. */
     members?: string[];
-    /** Phone numbers (<a href=\"https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628\" target=\"_blank\">MSISDNs</a>) of child group will be included in this group. If present then this group will be auto populated.  Constraints: Elements must be group IDs. */
+    /** Phone numbers ([MSISDNs](https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628)) of child group will be included in this group. If present then this group will be auto populated.  Constraints: Elements must be group IDs. */
     child_groups?: string[];
-    /** @see GroupObjectAutoUpdate */
-    auto_update?: GroupObjectAutoUpdate;
+    /** @see GroupAutoUpdate */
+    auto_update?: GroupAutoUpdate;
 }

package/dist/models/v1/enums.d.ts

@@ -1,2 +1,14 @@
-export type DeliveryReportEnum = 'none' | 'summary' | 'full' | 'per_recipient' | 'per_recipient_final';
-export type DeliveryReportStatusEnum = 'Queued' | 'Dispatched' | 'Aborted' | 'Cancelled' | 'Rejected' | 'Deleted' | 'Delivered' | 'Failed' | 'Expired' | 'Unknown';
+/**
+ * Kind of delivery report
+ */
+export type DeliveryReportEnum = 'none' | 'summary' | 'full' | 'per_recipient' | 'per_recipient_final' | string;
+/**
+ * The simplified status as described in _Delivery Report Statuses_.
+ */
+export type DeliveryStatusEnum = 'Queued' | 'Dispatched' | 'Aborted' | 'Cancelled' | 'Rejected' | 'Deleted' | 'Delivered' | 'Failed' | 'Expired' | 'Unknown' | string;
+/** @deprecated */
+export type DeliveryReportStatusEnum = DeliveryReportEnum;
+/**
+ * The delivery report status code provides a more detailed view of what happened with a message. The REST API error codes are a combination of [SMPP error codes](/docs/sms/smpp/error-codes/#status-reports-error-codes), [MMS error codes](/docs/mms/7-service/mms-status-codes/) and custom codes.
+ */
+export type DeliveryReceiptCodeEnum = 0 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | number;

package/dist/models/v1/group/group.d.ts

@@ -18,8 +18,8 @@ export interface Group {
     created_at?: Date;
     /** Timestamp for when the group was last updated. Format: YYYY-MM-DDThh:mm:ss.SSSZ */
     modified_at?: Date;
-    /** Phone numbers (MSISDNs) of child group will be included in this group. If present, this group will be auto populated.  Constraints: Elements must be group IDs. */
-    child_groups?: object[];
+    /** Phone numbers ([MSISDNs](https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628)) of child group will be included in this group. If present, this group will be auto populated.  Constraints: Elements must be group IDs. */
+    child_groups?: string[];
     /** @see GroupAutoUpdate */
     auto_update?: GroupAutoUpdate;
 }

package/dist/models/v1/group-auto-update/group-auto-update.d.ts

@@ -1,6 +1,10 @@
+import { AddKeyword } from '../add-keyword';
+import { RemoveKeyword } from '../remove-keyword';
 export interface GroupAutoUpdate {
-    /** Short code or long number addressed in <a href=\"https://community.sinch.com/t5/Glossary/MO-Mobile-Originated/ta-p/7618\" target=\"_blank\">MO</a>. Constraints: Must be valid MSISDN or short code. */
+    /** Short code or long number addressed in [MO](https://community.sinch.com/t5/Glossary/MO-Mobile-Originated/ta-p/7618).  Constraints:  Must be valid phone number or short code which has been **provisioned by your account manager**. */
     to: string;
-    add?: string;
-    remove?: string;
+    /** @see AddKeyword */
+    add?: AddKeyword;
+    /** @see RemoveKeyword */
+    remove?: RemoveKeyword;
 }

package/dist/models/v1/inbound-message-response/inbound-message-response.d.ts

@@ -1,3 +1,4 @@
 import { MOBinary } from '../mo-binary';
 import { MOText } from '../mo-text';
-export type InboundMessageResponse = MOText | MOBinary;
+import { MOMedia } from '../mo-media';
+export type InboundMessageResponse = MOText | MOBinary | MOMedia;

package/dist/models/v1/index.d.ts

@@ -1,3 +1,4 @@
+export * from './add-keyword';
 export * from './api-batch-list';
 export * from './delivery-feedback-request';
 export * from './api-inbound-list';
@@ -18,19 +19,21 @@ export * from './dry-run-response-per-recipient-inner';
 export * from './error-response-obj';
 export * from './group-auto-update';
 export * from './create-group-request';
-export * from './group-object-auto-update';
-export * from './group-object-auto-update-remove';
 export * from './inbound-message-response';
 export * from './list-groups-response';
-export * from './mo-binary';
-export * from './mo-text';
 export * from './media-body';
 export * from './media-request';
 export * from './media-response';
 export * from './message-delivery-status';
+export * from './mms-media';
+export * from './mms-mo-body';
+export * from './mo-binary';
+export * from './mo-media';
+export * from './mo-text';
 export * from './parameter-group';
 export * from './parameter-values';
 export * from './recipient-delivery-report';
+export * from './remove-keyword';
 export * from './replace-group-request';
 export * from './send-sms-response';
 export * from './send-sms-request';
@@ -38,8 +41,5 @@ export * from './text-request';
 export * from './text-response';
 export * from './update-batch-message-request';
 export * from './update-group-request';
-export * from './update-group-request-auto-update';
-export * from './update-group-request-auto-update-add';
-export * from './update-group-request-auto-update-remove';
 export * from './enums';
 export * from './requests';

package/dist/models/v1/index.js

@@ -14,6 +14,7 @@ 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 });
+__exportStar(require("./add-keyword"), exports);
 __exportStar(require("./api-batch-list"), exports);
 __exportStar(require("./delivery-feedback-request"), exports);
 __exportStar(require("./api-inbound-list"), exports);
@@ -34,19 +35,21 @@ __exportStar(require("./dry-run-response-per-recipient-inner"), exports);
 __exportStar(require("./error-response-obj"), exports);
 __exportStar(require("./group-auto-update"), exports);
 __exportStar(require("./create-group-request"), exports);
-__exportStar(require("./group-object-auto-update"), exports);
-__exportStar(require("./group-object-auto-update-remove"), exports);
 __exportStar(require("./inbound-message-response"), exports);
 __exportStar(require("./list-groups-response"), exports);
-__exportStar(require("./mo-binary"), exports);
-__exportStar(require("./mo-text"), exports);
 __exportStar(require("./media-body"), exports);
 __exportStar(require("./media-request"), exports);
 __exportStar(require("./media-response"), exports);
 __exportStar(require("./message-delivery-status"), exports);
+__exportStar(require("./mms-media"), exports);
+__exportStar(require("./mms-mo-body"), exports);
+__exportStar(require("./mo-binary"), exports);
+__exportStar(require("./mo-media"), exports);
+__exportStar(require("./mo-text"), exports);
 __exportStar(require("./parameter-group"), exports);
 __exportStar(require("./parameter-values"), exports);
 __exportStar(require("./recipient-delivery-report"), exports);
+__exportStar(require("./remove-keyword"), exports);
 __exportStar(require("./replace-group-request"), exports);
 __exportStar(require("./send-sms-response"), exports);
 __exportStar(require("./send-sms-request"), exports);
@@ -54,9 +57,6 @@ __exportStar(require("./text-request"), exports);
 __exportStar(require("./text-response"), exports);
 __exportStar(require("./update-batch-message-request"), exports);
 __exportStar(require("./update-group-request"), exports);
-__exportStar(require("./update-group-request-auto-update"), exports);
-__exportStar(require("./update-group-request-auto-update-add"), exports);
-__exportStar(require("./update-group-request-auto-update-remove"), exports);
 __exportStar(require("./enums"), exports);
 __exportStar(require("./requests"), exports);
 //# sourceMappingURL=index.js.map

package/dist/models/v1/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/v1/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,8DAA4C;AAC5C,qDAAmC;AACnC,6DAA2C;AAC3C,mDAAiC;AACjC,iEAA+C;AAC/C,8DAA4C;AAC5C,0DAAwC;AACxC,+DAA6C;AAC7C,mDAAiC;AACjC,oDAAkC;AAClC,0CAAwB;AACxB,oDAAkC;AAClC,yDAAuC;AACvC,oDAAkC;AAClC,qDAAmC;AACnC,yEAAuD;AACvD,uDAAqC;AACrC,sDAAoC;AACpC,yDAAuC;AACvC,6DAA2C;AAC3C,oEAAkD;AAClD,6DAA2C;AAC3C,yDAAuC;AACvC,8CAA4B;AAC5B,4CAA0B;AAC1B,+CAA6B;AAC7B,kDAAgC;AAChC,mDAAiC;AACjC,4DAA0C;AAC1C,oDAAkC;AAClC,qDAAmC;AACnC,8DAA4C;AAC5C,0DAAwC;AACxC,sDAAoC;AACpC,qDAAmC;AACnC,iDAA+B;AAC/B,kDAAgC;AAChC,iEAA+C;AAC/C,yDAAuC;AACvC,qEAAmD;AACnD,yEAAuD;AACvD,4EAA0D;AAC1D,0CAAwB;AACxB,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/v1/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,mDAAiC;AACjC,8DAA4C;AAC5C,qDAAmC;AACnC,6DAA2C;AAC3C,mDAAiC;AACjC,iEAA+C;AAC/C,8DAA4C;AAC5C,0DAAwC;AACxC,+DAA6C;AAC7C,mDAAiC;AACjC,oDAAkC;AAClC,0CAAwB;AACxB,oDAAkC;AAClC,yDAAuC;AACvC,oDAAkC;AAClC,qDAAmC;AACnC,yEAAuD;AACvD,uDAAqC;AACrC,sDAAoC;AACpC,yDAAuC;AACvC,6DAA2C;AAC3C,yDAAuC;AACvC,+CAA6B;AAC7B,kDAAgC;AAChC,mDAAiC;AACjC,4DAA0C;AAC1C,8CAA4B;AAC5B,gDAA8B;AAC9B,8CAA4B;AAC5B,6CAA2B;AAC3B,4CAA0B;AAC1B,oDAAkC;AAClC,qDAAmC;AACnC,8DAA4C;AAC5C,mDAAiC;AACjC,0DAAwC;AACxC,sDAAoC;AACpC,qDAAmC;AACnC,iDAA+B;AAC/B,kDAAgC;AAChC,iEAA+C;AAC/C,yDAAuC;AACvC,0CAAwB;AACxB,6CAA2B"}

package/dist/models/v1/media-body/media-body.d.ts

@@ -2,6 +2,8 @@
  * The message content, including a URL to the media file
  */
 export interface MediaBody {
+    /** The subject text */
+    subject?: string;
     /** The message text. Text only media messages will be rejected, please use SMS instead. */
     message?: string;
     /** URL to the media file */

package/dist/models/v1/media-request/media-request.d.ts

@@ -5,7 +5,7 @@ import { DeliveryReportEnum } from '../enums';
  * Only available in the US. Contact support if you wish to send MMS.
  */
 export interface MediaRequest {
-    /** List of Phone numbers and group IDs that will receive the batch. <a href=\"https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628\" target=\"_blank\">More info</a> */
+    /** List of Phone numbers and group IDs that will receive the batch. [More info](https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628) */
     to: string[];
     /** Sender number. Must be valid phone number, short code or alphanumeric. Required if Automatic Default Originator not configured. */
     from?: string;
@@ -18,17 +18,17 @@ export interface MediaRequest {
     /** Request delivery report callback. Note that delivery reports can be fetched from the API regardless of this setting. */
     delivery_report?: DeliveryReportEnum;
     /** If set in the future, the message will be delayed until `send_at` occurs.
-     *  Must be before `expire_at`. If set in the past, messages will be sent immediately. Formatted as <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO-8601</a>: `YYYY-MM-DDThh:mm:ss.SSSZ`.  */
+     *  Must be before `expire_at`. If set in the past, messages will be sent immediately. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.  */
     send_at?: Date;
     /** If set, the system will stop trying to deliver the message at this point.
-     * Must be after `send_at`. Default and max is 3 days after `send_at`. Formatted as <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO-8601</a>: `YYYY-MM-DDThh:mm:ss.SSSZ`.  */
+     * Must be after `send_at`. Default and max is 3 days after `send_at`. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.  */
     expire_at?: Date;
     /** Override the default callback URL for this batch. Must be valid URL. */
     callback_url?: string;
     /** The client identifier of a batch message. If set, the identifier will be added in the delivery report/callback of this batch */
     client_reference?: string;
-    /** If set to `true`, then [feedback](/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
+    /** If set to `true`, then [feedback](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
     feedback_enabled?: boolean;
-    /** Whether or not you want the media included in your message to be checked against [Sinch MMS channel best practices](/docs/mms/bestpractices/). If set to true, your message will be rejected if it doesn\'t conform to the listed recommendations, otherwise no validation will be performed.  */
+    /** Whether or not you want the media included in your message to be checked against [Sinch MMS channel best practices](https://developers.sinch.com/docs/mms/bestpractices/). If set to true, your message will be rejected if it doesn't conform to the listed recommendations, otherwise no validation will be performed.  */
     strict_validation?: boolean;
 }

package/dist/models/v1/media-response/media-response.d.ts

@@ -16,23 +16,23 @@ export interface MediaResponse {
     parameters?: ParameterGroup;
     /** Media message */
     type?: 'mt_media';
-    /** Timestamp for when batch was created. YYYY-MM-DDThh:mm:ss.SSSZ format */
+    /** Timestamp for when batch was created. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601):`YYYY-MM-DDThh:mm:ss.SSSZ`. */
     created_at?: Date;
-    /** Timestamp for when batch was last updated. YYYY-MM-DDThh:mm:ss.SSSZ format */
+    /** Timestamp for when batch was last updated. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601):`YYYY-MM-DDThh:mm:ss.SSSZ`. */
     modified_at?: Date;
     /** Request delivery report callback. Note that delivery reports can be fetched from the API regardless of this setting.  */
     delivery_report?: DeliveryReportEnum;
     /** If set in the future the message will be delayed until send_at occurs.
-     * Must be before `expire_at`. If set in the past messages will be sent immediately. YYYY-MM-DDThh:mm:ss.SSSZ format */
+     * Must be before `expire_at`. If set in the past messages will be sent immediately. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601):`YYYY-MM-DDThh:mm:ss.SSSZ`. */
     send_at?: Date;
     /** If set the system will stop trying to deliver the message at this point.
-     * Must be after `send_at`. Default and max is 3 days after send_at. YYYY-MM-DDThh:mm:ss.SSSZ format */
+     * Must be after `send_at`. Default and max is 3 days after send_at. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601):`YYYY-MM-DDThh:mm:ss.SSSZ`. */
     expire_at?: Date;
     /** Override the default callback URL for this batch. Must be valid URL. */
     callback_url?: string;
     /** The client identifier of a batch message. If set, the identifier will be added in the delivery report/callback of this batch */
     client_reference?: string;
-    /** If set to true then [feedback](/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
+    /** If set to true then [feedback](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Batches/#tag/Batches/operation/deliveryFeedback) is expected after successful delivery. */
     feedback_enabled?: boolean;
     /** Whether or not you want the media included in your message to be checked against [Sinch MMS channel best practices](/docs/mms/bestpractices/). If set to true, your message will be rejected if it doesn't conform to the listed recommendations, otherwise no validation will be performed. */
     strict_validation?: boolean;

package/dist/models/v1/message-delivery-status/message-delivery-status.d.ts

@@ -1,14 +1,14 @@
-import { DeliveryReportStatusEnum } from '../enums';
+import { DeliveryReceiptCodeEnum, DeliveryStatusEnum } from '../enums';
 /**
  * Array with status objects. Only status codes with at least one recipient will be listed.
  */
 export interface MessageDeliveryStatus {
-    /** The detailed status code. */
-    code: number;
+    /** The detailed [status code](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/section/Delivery-report-error-codes). */
+    code: DeliveryReceiptCodeEnum;
     /** The number of messages that currently has this code. */
     count: number;
     /** Only for `full` report. A list of the phone number recipients which messages has this status code. */
     recipients?: string[];
     /** The simplified status as described in _Delivery Report Statuses_. */
-    status: DeliveryReportStatusEnum;
+    status: DeliveryStatusEnum;
 }

package/dist/models/v1/mms-media/index.d.ts

@@ -0,0 +1 @@
+export type { MmsMedia } from './mms-media';

package/dist/models/v1/mms-media/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/mms-media/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/mms-media/mms-media.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Collection of attachments in incoming message.
+ */
+export interface MmsMedia {
+    /** The result code. Possible values: 0 (success), 1 (content upload error), 2 (cloud bucket error), 3 (bucket key error). */
+    code: number;
+    /** Content type of binary. [More info](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) */
+    content_type: string;
+    /** Status of the uploaded media. */
+    status: 'Uploaded' | 'Failed' | string;
+    /** URL to be used to download attachment. */
+    url?: string;
+}

package/dist/models/v1/mms-media/mms-media.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mms-media.js.map

package/dist/models/v1/mms-media/mms-media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mms-media.js","sourceRoot":"","sources":["../../../../src/models/v1/mms-media/mms-media.ts"],"names":[],"mappings":""}

package/dist/models/v1/mms-mo-body/index.d.ts

@@ -0,0 +1 @@
+export type { MmsMoBody } from './mms-mo-body';

package/dist/models/v1/mms-mo-body/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/mms-mo-body/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/mms-mo-body/mms-mo-body.d.ts

@@ -0,0 +1,12 @@
+import { MmsMedia } from '../mms-media';
+/**
+ * The message content, including a URL to the media filters.
+ */
+export interface MmsMoBody {
+    /** The subject of the MMS media message. */
+    subject?: string;
+    /** The text message content of the MMS media message. */
+    message?: string;
+    /** List of MmsMedias */
+    media?: MmsMedia[];
+}

package/dist/models/v1/mms-mo-body/mms-mo-body.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mms-mo-body.js.map

package/dist/models/v1/mms-mo-body/mms-mo-body.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mms-mo-body.js","sourceRoot":"","sources":["../../../../src/models/v1/mms-mo-body/mms-mo-body.ts"],"names":[],"mappings":""}

package/dist/models/v1/mo-binary/mo-binary.d.ts

@@ -2,7 +2,7 @@ import { ApiMoMessage } from '../api-mo-message';
 export interface MOBinary extends ApiMoMessage {
     /** The message content Base64 encoded.   Max 140 bytes together with udh.  */
     body: string;
-    /** SMS in binary format */
+    /** SMS in [binary](https://community.sinch.com/t5/Glossary/Binary-SMS/ta-p/7470) format */
     type: 'mo_binary';
     /** The UDH header of a binary message HEX encoded. Max 140 bytes together with body. */
     udh: string;

package/dist/models/v1/mo-media/index.d.ts

@@ -0,0 +1 @@
+export type { MOMedia } from './mo-media';

package/dist/models/v1/mo-media/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/mo-media/index.ts"],"names":[],"mappings":""}

package/dist/models/v1/mo-media/mo-media.d.ts

@@ -0,0 +1,8 @@
+import { MmsMoBody } from '../mms-mo-body';
+import { ApiMoMessage } from '../api-mo-message';
+export interface MOMedia extends ApiMoMessage {
+    /** MMS */
+    type: 'mo_media';
+    /** @see MmsMoBody */
+    body: MmsMoBody;
+}

package/dist/models/v1/mo-media/mo-media.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mo-media.js.map

package/dist/models/v1/mo-media/mo-media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mo-media.js","sourceRoot":"","sources":["../../../../src/models/v1/mo-media/mo-media.ts"],"names":[],"mappings":""}