@sinch/sms 0.0.4 → 1.0.0

package/README.md

@@ -2,9 +2,6 @@
 
 This package contains the Sinch SMS SDK for Node.js for use with [Sinch APIs](https://developers.sinch.com/). To use it, you will need a Sinch account. Please [sign up](https://dashboard.sinch.com/signup) or [log in](https://dashboard.sinch.com/login) if you already have one.
 
-> <span style="color:red; font-weight:bold">Warning:</span>
-> **This SDK is currently available to selected developers for preview use only. It is being provided for the purpose of collecting feedback, and should not be used in production environments.**
-
 ## Installation
 
 We recommend to use this SDK as part of the [`@sinch/sdk-core`](../../packages/sdk-core) package in order to make the most out of all the Sinch products.
@@ -43,20 +40,19 @@ If you are using this SDK as part of the Sinch SDK (`@sinch/sdk-core`) you can a
 
 ```typescript
 import { 
-  SendSMSRequestData,
-  SendSMSResponse,
+  Sms,
   SmsService,
   SinchClient,
   ServicePlanIdCredentials,
   UnifiedCredentials,
-  Region,
+  SmsRegion,
 } from '@sinch/sdk-core';
 
 const credentialsWithProjectId: UnifiedCredentials = {
   projectId: 'PROJECT_ID',
   keyId: 'KEY_ID',
   keySecret: 'KEY_SECRET',
-  region: Region.UNITED_STATES, // Optional, default is 'us'. Only other possibility is 'eu'
+  smsRegion: SmsRegion.UNITED_STATES, // Optional, default is 'us'. Only other possibility is 'eu'
 };
 // Access the 'sms' service registered on the Sinch Client
 const sinchClientCreatedWithProjectId = new SinchClient(credentialsWithProjectId);
@@ -65,25 +61,25 @@ const smsServiceWithProjectId: SmsService = sinchClientCreatedWithProjectId.sms;
 const credentialsWithServicePlanId: ServicePlanIdCredentials = {
   servicePlanId: 'SERVICE_PLAN_ID',
   apiToken: 'API_TOKEN',
-  region: Region.UNITED_STATES, // Optional, default is 'us'. Other possibilities are 'eu', 'br', 'au' and 'ca'
+  smsRegion: SmsRegion.UNITED_STATES, // Optional, default is 'us'. Other possibilities are 'eu', 'br', 'au' and 'ca'
 };
 // Access the 'sms' service registered on the Sinch Client
 const sinchClientCreatedWithServicePlanId = new SinchClient(credentialsWithServicePlanId);
 const smsServiceWithServicePlanId: SmsService = sinchClientCreatedWithServicePlanId.sms;
 
 // Build the request data
-const requestData: SendSMSRequestData = {
+const requestData: Sms.SendSMSRequestData = {
   sendSMSRequestBody: {
     to: [
        '+12223334444',
-       '+12223335555'
+       '+12223335555',
     ],
     from: '+12228889999',
     parameters: {
        name: {
           '+12223334444': 'John',
           default: 'there',
-       }
+       },
     },
     body: 'Hi ${name}',
     type: 'mt_text', 
@@ -92,12 +88,12 @@ const requestData: SendSMSRequestData = {
 
 // Use the 'sms' service registered on the Sinch client
 // The request will be authenticated with OAuth2 and sent to https://zt.us.sms.api.sinch.com
-const availabilityResult_1: SendSMSResponse 
+const availabilityResult_1: Sms.SendSMSResponse 
     = await smsServiceWithProjectId.batches.send(requestData);
 
 // Use the 'sms' service registered on the Sinch client
 // The request will be authenticated with the API Token and sent to https://us.sms.api.sinch.com
-const availabilityResult_2: SendSMSResponse 
+const availabilityResult_2: Sms.SendSMSResponse 
     = await smsServiceWithServicePlanId.batches.send(requestData);
 ```
 
@@ -107,13 +103,12 @@ The SDK can be used standalone if you need to use only the SMS APIs. As for a us
 
 ```typescript
 import {
-  Region,
+  SmsRegion,
   ServicePlanIdCredentials,
   UnifiedCredentials,
  } from '@sinch/sdk-client';
 import { 
-  SendSMSRequestData,
-  SendSMSResponse,
+  Sms,
   SmsService,
 } from '@sinch/sms';
 
@@ -121,7 +116,7 @@ const credentialsWithProjectId: UnifiedCredentials = {
   projectId: 'PROJECT_ID',
   keyId: 'KEY_ID',
   keySecret: 'KEY_SECRET',
-  region: Region.UNITED_STATES, // Optional, default is 'us'. Only other possibility is 'eu'
+  smsRegion: SmsRegion.UNITED_STATES, // Optional, default is 'us'. Only other possibility is 'eu'
 };
 // Declare the 'sms' service in a standalone way
 const smsServiceWithProjectId = new SmsService(credentialsWithProjectId);
@@ -129,23 +124,23 @@ const smsServiceWithProjectId = new SmsService(credentialsWithProjectId);
 const credentialsWithServicePlanId: ServicePlanIdCredentials = {
   servicePlanId: 'SERVICE_PLAN_ID',
   apiToken: 'API_TOKEN',
-  region: Region.UNITED_STATES, // Optional, default is 'us'. Other possibilities are 'eu', 'br', 'au' and 'ca'
+  smsRegion: SmsRegion.UNITED_STATES, // Optional, default is 'us'. Other possibilities are 'eu', 'br', 'au' and 'ca'
 };
 // Declare the 'sms' service in a standalone way
 const smsServiceWithServicePlanId = new SmsService(credentialsWithServicePlanId);
 
 // Build the request data
-const requestData: SendSMSRequestData = {
+const requestData: Sms.SendSMSRequestData = {
     // some request parameters
 };
 
 // Use the standalone declaration of the 'sms' service
 // The request will be authenticated with OAuth2 and sent to https://zt.us.sms.api.sinch.com
-const response_1: SendSMSResponse = await smsServiceWithProjectId.batches.send(requestData);
+const response_1: Sms.SendSMSResponse = await smsServiceWithProjectId.batches.send(requestData);
 
 // Use the standalone declaration of the 'sms' service
 // The request will be authenticated with the API Token and sent to https://us.sms.api.sinch.com
-const response_2: SendSMSResponse = await smsServiceWithServicePlanId.batches.send(requestData);
+const response_2: Sms.SendSMSResponse = await smsServiceWithServicePlanId.batches.send(requestData);
 ```
 
 ## Promises
@@ -154,7 +149,7 @@ All the methods that interact with the Sinch APIs use Promises. You can use `awa
 
 ```typescript
 // Method 1: Wait for the Promise to complete (you need to be in an 'async' method)
-let batchResponse: SendSMSResponse;
+let batchResponse: Sms.SendSMSResponse;
 try {
   batchResponse = await smsService.batches.send(requestData);
   console.log(`The SMS has been sent successfully: batch id = ${batchResponse.id}`);

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from './models';
+export * as Sms from './models';
 export * from './rest';
 export * from '@sinch/sdk-client';

package/dist/index.js

@@ -10,11 +10,24 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 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("./models"), exports);
+exports.Sms = void 0;
+exports.Sms = __importStar(require("./models"));
 __exportStar(require("./rest"), exports);
 __exportStar(require("@sinch/sdk-client"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,yCAAuB;AACvB,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAgC;AAChC,yCAAuB;AACvB,oDAAkC"}

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

@@ -42,3 +42,4 @@ 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

@@ -58,4 +58,5 @@ __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,0DAAwC;AACxC,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,kDAAgC;AAChC,gEAA8C;AAC9C,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"}
+{"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,0DAAwC;AACxC,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,kDAAgC;AAChC,gEAA8C;AAC9C,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"}

package/dist/models/v1/requests/batches/batches-request-data.d.ts

@@ -0,0 +1,71 @@
+import { DeliveryFeedbackRequest } from '../../delivery-feedback-request';
+import { DryRunRequest, ReplaceBatchMessageRequest } from '../../dry-run-request';
+import { SendSMSRequest } from '../../send-sms-request';
+import { TextRequest } from '../../text-request';
+import { BinaryRequest } from '../../binary-request';
+import { MediaRequest } from '../../media-request';
+import { UpdateBatchMessageRequest } from '../../update-batch-message-request';
+export interface CancelBatchMessageRequestData {
+    /** The batch ID you received from sending a message. */
+    'batch_id': string;
+}
+export interface DeliveryFeedbackRequestData {
+    /** The batch ID you received from sending a message. */
+    'batch_id': string;
+    /** A list of phone numbers (MSISDNs) that successfully received the message. */
+    'deliveryFeedbackRequestBody': DeliveryFeedbackRequest;
+}
+export interface DryRunRequestData {
+    /** Whether to include per recipient details in the response */
+    'per_recipient'?: boolean;
+    /** Max number of recipients to include per recipient details for in the response */
+    'number_of_recipients'?: number;
+    /**  */
+    'dryRunRequestBody'?: DryRunRequest;
+}
+export interface GetBatchMessageRequestData {
+    /** The batch ID you received from sending a message. */
+    'batch_id': string;
+}
+export interface ListBatchesRequestData {
+    /** The page number starting from 0. */
+    'page'?: number;
+    /** Determines the size of a page. */
+    'page_size'?: number;
+    /** Only list messages sent from this sender number. Multiple originating numbers can be comma separated. Must be phone numbers or short code. */
+    'from'?: string;
+    /** Only list messages received at or after this date/time. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.  Default: Now-24 */
+    'start_date'?: Date;
+    /** Only list messages received before this date/time. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`. */
+    'end_date'?: Date;
+    /** Client reference to include */
+    'client_reference'?: string;
+}
+export interface ReplaceBatchMessageRequestData {
+    /** The batch ID you received from sending a message. */
+    'batch_id': string;
+    /**  */
+    'replaceBatchMessageRequestBody'?: ReplaceBatchMessageRequest;
+}
+export interface SendSMSRequestData {
+    /** Default schema is Text if type is not specified. */
+    'sendSMSRequestBody'?: SendSMSRequest;
+}
+export interface SendTextSMSRequestData {
+    /** TextMessage request body */
+    'sendSMSRequestBody'?: TextRequest;
+}
+export interface SendBinarySMSRequestData {
+    /** BinaryMessage request body */
+    'sendSMSRequestBody'?: BinaryRequest;
+}
+export interface SendMediaSMSRequestData {
+    /** MediaMessage request body */
+    'sendSMSRequestBody'?: MediaRequest;
+}
+export interface UpdateBatchMessageRequestData {
+    /** The batch ID you received from sending a message. */
+    'batch_id': string;
+    /**  */
+    'updateBatchMessageRequestBody'?: UpdateBatchMessageRequest;
+}

package/dist/models/v1/requests/batches/batches-request-data.js

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

package/dist/models/v1/requests/batches/batches-request-data.js.map

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

package/dist/models/v1/requests/delivery-reports/delivery-reports-request-data.d.ts

@@ -0,0 +1,33 @@
+import { DeliveryReportStatusEnum } from '../../enums';
+export interface GetDeliveryReportByBatchIdRequestData {
+    /** The batch ID you received from sending a message. */
+    'batch_id': string;
+    /** The type of delivery report.  - A `summary` will count the number of messages sent per status.  - A `full` report give that of a `summary` report but in addition, lists phone numbers. */
+    'type'?: 'summary' | 'full';
+    /** Comma separated list of delivery_report_statuses to include */
+    'status'?: DeliveryReportStatusEnum[];
+    /** Comma separated list of delivery_receipt_error_codes to include */
+    'code'?: string;
+}
+export interface GetDeliveryReportByPhoneNumberRequestData {
+    /** The batch ID you received from sending a message. */
+    'batch_id': string;
+    /** Phone number for which you to want to search. */
+    'recipient_msisdn': string;
+}
+export interface ListDeliveryReportsRequestData {
+    /** The page number starting from 0. */
+    'page'?: number;
+    /** Determines the size of a page. */
+    'page_size'?: number;
+    /** Only list messages received at or after this date/time. Default: 24h ago */
+    'start_date'?: Date;
+    /** Only list messages received before this date/time. */
+    'end_date'?: Date;
+    /** Comma separated list of delivery report statuses to include. */
+    'status'?: DeliveryReportStatusEnum[];
+    /** Comma separated list of delivery receipt error codes to include. */
+    'code'?: string;
+    /** Client reference to include */
+    'client_reference'?: string;
+}

package/dist/models/v1/requests/delivery-reports/delivery-reports-request-data.js

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

package/dist/models/v1/requests/delivery-reports/delivery-reports-request-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delivery-reports-request-data.js","sourceRoot":"","sources":["../../../../../src/models/v1/requests/delivery-reports/delivery-reports-request-data.ts"],"names":[],"mappings":""}

package/dist/models/v1/requests/groups/groups-request-data.d.ts

@@ -0,0 +1,37 @@
+import { CreateGroupRequest } from '../../create-group-request';
+import { ReplaceGroupRequest } from '../../replace-group-request';
+import { UpdateGroupRequest } from '../../update-group-request';
+export interface CreateGroupRequestData {
+    /**  */
+    'createGroupRequestBody'?: CreateGroupRequest;
+}
+export interface DeleteGroupRequestData {
+    /** ID of a group that you are interested in getting. */
+    'group_id': string;
+}
+export interface ListMembersRequestData {
+    /** ID of a group that you are interested in getting. */
+    'group_id': string;
+}
+export interface ListGroupsRequestData {
+    /** The page number starting from 0. */
+    'page'?: number;
+    /** Determines the size of a page. */
+    'page_size'?: number;
+}
+export interface ReplaceGroupRequestData {
+    /** ID of a group that you are interested in getting. */
+    'group_id': string;
+    /**  */
+    'replaceGroupRequestBody'?: ReplaceGroupRequest;
+}
+export interface GetGroupRequestData {
+    /** ID of a group that you are interested in getting. */
+    'group_id': string;
+}
+export interface UpdateGroupRequestData {
+    /** ID of a group that you are interested in getting. */
+    'group_id': string;
+    /**  */
+    'updateGroupRequestBody'?: UpdateGroupRequest;
+}

package/dist/models/v1/requests/groups/groups-request-data.js

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

package/dist/models/v1/requests/groups/groups-request-data.js.map

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

package/dist/models/v1/requests/inbounds/inbounds-request-data.d.ts

@@ -0,0 +1,18 @@
+export interface ListInboundMessagesRequestData {
+    /** The page number starting from 0. */
+    'page'?: number;
+    /** Determines the size of a page */
+    'page_size'?: number;
+    /** Only list messages sent to this destination. Multiple phone numbers formatted as either <a href=\"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537\" target=\"_blank\">E.164</a> or short codes can be comma separated. */
+    'to'?: string;
+    /** Only list messages received at or after this date/time. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.  Default: Now-24 */
+    'start_date'?: Date;
+    /** Only list messages received before this date/time. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`. */
+    'end_date'?: Date;
+    /** Using a client reference in inbound messages requires additional setup on your account. Contact your [account manager](https://dashboard.sinch.com/settings/account-details) to enable this feature.  Only list inbound messages that are in response to messages with a previously provided client reference. */
+    'client_reference'?: string;
+}
+export interface GetInboundMessageRequestData {
+    /** The inbound ID found when listing inbound messages. */
+    'inbound_id': string;
+}

package/dist/models/v1/requests/inbounds/inbounds-request-data.js

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

package/dist/models/v1/requests/inbounds/inbounds-request-data.js.map

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

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

@@ -0,0 +1,4 @@
+export * from './batches/batches-request-data';
+export * from './delivery-reports/delivery-reports-request-data';
+export * from './groups/groups-request-data';
+export * from './inbounds/inbounds-request-data';

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

@@ -0,0 +1,21 @@
+"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 });
+__exportStar(require("./batches/batches-request-data"), exports);
+__exportStar(require("./delivery-reports/delivery-reports-request-data"), exports);
+__exportStar(require("./groups/groups-request-data"), exports);
+__exportStar(require("./inbounds/inbounds-request-data"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/requests/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iEAA+C;AAC/C,mFAAiE;AACjE,+DAA6C;AAC7C,mEAAiD"}

package/dist/rest/v1/batches/batches-api.d.ts

@@ -1,67 +1,6 @@
-import { CancelBatchMessageResponse, DeliveryFeedbackRequest, DryRunResponse, DryRunRequest, ReplaceBatchMessageResponse, ReplaceBatchMessageRequest, SendSMSResponse, SendSMSRequest, UpdateBatchMessageRequest, TextRequest, BinaryRequest, MediaRequest, BinaryResponse, TextResponse, MediaResponse } from '../../../models';
+import { CancelBatchMessageResponse, DryRunResponse, ReplaceBatchMessageResponse, SendSMSResponse, BinaryResponse, TextResponse, MediaResponse, CancelBatchMessageRequestData, DeliveryFeedbackRequestData, DryRunRequestData, GetBatchMessageRequestData, ListBatchesRequestData, ReplaceBatchMessageRequestData, SendSMSRequestData, SendTextSMSRequestData, SendBinarySMSRequestData, SendMediaSMSRequestData, UpdateBatchMessageRequestData } from '../../../models';
 import { ApiListPromise, SinchClientParameters } from '@sinch/sdk-client';
 import { SmsDomainApi } from '../sms-domain-api';
-export interface CancelBatchMessageRequestData {
-    /** The batch ID you received from sending a message. */
-    'batch_id': string;
-}
-export interface DeliveryFeedbackRequestData {
-    /** The batch ID you received from sending a message. */
-    'batch_id': string;
-    /** A list of phone numbers (MSISDNs) that successfully received the message. */
-    'deliveryFeedbackRequestBody': DeliveryFeedbackRequest;
-}
-export interface DryRunRequestData {
-    /** Whether to include per recipient details in the response */
-    'per_recipient'?: boolean;
-    /** Max number of recipients to include per recipient details for in the response */
-    'number_of_recipients'?: number;
-    /**  */
-    'dryRunRequestBody'?: DryRunRequest;
-}
-export interface GetBatchMessageRequestData {
-    /** The batch ID you received from sending a message. */
-    'batch_id': string;
-}
-export interface ListBatchesRequestData {
-    /** The page number starting from 0. */
-    'page'?: number;
-    /** Determines the size of a page. */
-    'page_size'?: number;
-    /** Only list messages sent from this sender number. Multiple originating numbers can be comma separated. Must be phone numbers or short code. */
-    'from'?: string;
-    /** Only list messages received at or after this date/time. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`.  Default: Now-24 */
-    'start_date'?: Date;
-    /** Only list messages received before this date/time. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDThh:mm:ss.SSSZ`. */
-    'end_date'?: Date;
-    /** Client reference to include */
-    'client_reference'?: string;
-}
-export interface ReplaceBatchMessageRequestData {
-    /** The batch ID you received from sending a message. */
-    'batch_id': string;
-    /**  */
-    'replaceBatchMessageRequestBody'?: ReplaceBatchMessageRequest;
-}
-export interface SendSMSRequestData {
-    /** Default schema is Text if type is not specified. */
-    'sendSMSRequestBody'?: SendSMSRequest;
-}
-export interface SendTextSMSRequestData {
-    'sendSMSRequestBody'?: TextRequest;
-}
-export interface SendBinarySMSRequestData {
-    'sendSMSRequestBody'?: BinaryRequest;
-}
-export interface SendMediaSMSRequestData {
-    'sendSMSRequestBody'?: MediaRequest;
-}
-export interface UpdateBatchMessageRequestData {
-    /** The batch ID you received from sending a message. */
-    'batch_id': string;
-    /**  */
-    'updateBatchMessageRequestBody'?: UpdateBatchMessageRequest;
-}
 export declare class BatchesApi extends SmsDomainApi {
     /**
      * Initialize your interface

package/dist/rest/v1/batches/batches-api.jest.fixture.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="jest" />
-import { BatchesApi, CancelBatchMessageRequestData, DeliveryFeedbackRequestData, DryRunRequestData, GetBatchMessageRequestData, ListBatchesRequestData, ReplaceBatchMessageRequestData, SendBinarySMSRequestData, SendMediaSMSRequestData, SendSMSRequestData, SendTextSMSRequestData, UpdateBatchMessageRequestData } from './batches-api';
-import { BinaryResponse, DryRunResponse, MediaResponse, SendSMSResponse, TextResponse } from '../../../models';
+import { BatchesApi } from './batches-api';
+import { BinaryResponse, CancelBatchMessageRequestData, DeliveryFeedbackRequestData, DryRunRequestData, DryRunResponse, GetBatchMessageRequestData, ListBatchesRequestData, MediaResponse, ReplaceBatchMessageRequestData, SendBinarySMSRequestData, SendMediaSMSRequestData, SendSMSRequestData, SendSMSResponse, SendTextSMSRequestData, TextResponse, UpdateBatchMessageRequestData } from '../../../models';
 import { ApiListPromise } from '@sinch/sdk-client';
 export declare class BatchesApiFixture implements Partial<Readonly<BatchesApi>> {
     /**

package/dist/rest/v1/batches/batches-api.jest.fixture.js.map

@@ -1 +1 @@
-{"version":3,"file":"batches-api.jest.fixture.js","sourceRoot":"","sources":["../../../../src/rest/v1/batches/batches-api.jest.fixture.ts"],"names":[],"mappings":";;;AAiBA,MAAa,iBAAiB;IAA9B;QAEE;;YAEI;QACG,WAAM,GAAyE,IAAI,CAAC,EAAE,EAAE,CAAC;QAChG;;YAEI;QACG,yBAAoB,GAA4D,IAAI,CAAC,EAAE,EAAE,CAAC;QACjG;;YAEI;QACG,WAAM,GAA4D,IAAI,CAAC,EAAE,EAAE,CAAC;QACnF;;YAEI;QACG,QAAG,GAAsE,IAAI,CAAC,EAAE,EAAE,CAAC;QAC1F;;YAEI;QACG,SAAI,GAAyE,IAAI,CAAC,EAAE,EAAE,CAAC;QAC9F;;YAEI;QACG,YAAO,GAA0E,IAAI,CAAC,EAAE,EAAE,CAAC;QAClG;;YAEI;QACG,SAAI,GAA8D,IAAI,CAAC,EAAE,EAAE,CAAC;QACnF;;WAEG;QACI,oBAAe,GAA+D,IAAI,CAAC,EAAE,EAAE,CAAC;QAC/F;;WAEG;QACI,sBAAiB,GAAmE,IAAI,CAAC,EAAE,EAAE,CAAC;QACrG;;WAEG;QACI,qBAAgB,GAAiE,IAAI,CAAC,EAAE,EAAE,CAAC;QAClG;;YAEI;QACG,WAAM,GAAyE,IAAI,CAAC,EAAE,EAAE,CAAC;IAClG,CAAC;CAAA;AA9CD,8CA8CC"}
+{"version":3,"file":"batches-api.jest.fixture.js","sourceRoot":"","sources":["../../../../src/rest/v1/batches/batches-api.jest.fixture.ts"],"names":[],"mappings":";;;AAqBA,MAAa,iBAAiB;IAA9B;QAEE;;YAEI;QACG,WAAM,GAAyE,IAAI,CAAC,EAAE,EAAE,CAAC;QAChG;;YAEI;QACG,yBAAoB,GAA4D,IAAI,CAAC,EAAE,EAAE,CAAC;QACjG;;YAEI;QACG,WAAM,GAA4D,IAAI,CAAC,EAAE,EAAE,CAAC;QACnF;;YAEI;QACG,QAAG,GAAsE,IAAI,CAAC,EAAE,EAAE,CAAC;QAC1F;;YAEI;QACG,SAAI,GAAyE,IAAI,CAAC,EAAE,EAAE,CAAC;QAC9F;;YAEI;QACG,YAAO,GAA0E,IAAI,CAAC,EAAE,EAAE,CAAC;QAClG;;YAEI;QACG,SAAI,GAA8D,IAAI,CAAC,EAAE,EAAE,CAAC;QACnF;;WAEG;QACI,oBAAe,GAA+D,IAAI,CAAC,EAAE,EAAE,CAAC;QAC/F;;WAEG;QACI,sBAAiB,GAAmE,IAAI,CAAC,EAAE,EAAE,CAAC;QACrG;;WAEG;QACI,qBAAgB,GAAiE,IAAI,CAAC,EAAE,EAAE,CAAC;QAClG;;YAEI;QACG,WAAM,GAAyE,IAAI,CAAC,EAAE,EAAE,CAAC;IAClG,CAAC;CAAA;AA9CD,8CA8CC"}

package/dist/rest/v1/batches/batches-api.js

@@ -25,9 +25,9 @@ class BatchesApi extends sms_domain_api_1.SmsDomainApi {
             'Accept': 'application/json',
         };
         const body = '';
-        const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
+        const basePathUrl = `${this.client.apiClientOptions.hostname}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
         const requestOptions = await this.client.prepareOptions(basePathUrl, 'DELETE', getParams, headers, body || undefined);
-        const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
+        const url = this.client.prepareUrl(requestOptions.hostname, requestOptions.queryParams);
         return this.client.processCall({
             url,
             requestOptions,
@@ -50,9 +50,9 @@ class BatchesApi extends sms_domain_api_1.SmsDomainApi {
             'Accept': 'application/json',
         };
         const body = data['deliveryFeedbackRequestBody'] ? JSON.stringify(data['deliveryFeedbackRequestBody']) : '{}';
-        const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}/delivery_feedback`;
+        const basePathUrl = `${this.client.apiClientOptions.hostname}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}/delivery_feedback`;
         const requestOptions = await this.client.prepareOptions(basePathUrl, 'POST', getParams, headers, body || undefined);
-        const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
+        const url = this.client.prepareUrl(requestOptions.hostname, requestOptions.queryParams);
         return this.client.processCall({
             url,
             requestOptions,
@@ -77,9 +77,9 @@ class BatchesApi extends sms_domain_api_1.SmsDomainApi {
             'Accept': 'application/json',
         };
         const body = data['dryRunRequestBody'] ? JSON.stringify(data['dryRunRequestBody']) : '{}';
-        const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/dry_run`;
+        const basePathUrl = `${this.client.apiClientOptions.hostname}/xms/v1/${this.client.apiClientOptions.projectId}/batches/dry_run`;
         const requestOptions = await this.client.prepareOptions(basePathUrl, 'POST', getParams, headers, body || undefined);
-        const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
+        const url = this.client.prepareUrl(requestOptions.hostname, requestOptions.queryParams);
         return this.client.processCall({
             url,
             requestOptions,
@@ -100,9 +100,9 @@ class BatchesApi extends sms_domain_api_1.SmsDomainApi {
             'Accept': 'application/json',
         };
         const body = '';
-        const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
+        const basePathUrl = `${this.client.apiClientOptions.hostname}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
         const requestOptions = await this.client.prepareOptions(basePathUrl, 'GET', getParams, headers, body || undefined);
-        const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
+        const url = this.client.prepareUrl(requestOptions.hostname, requestOptions.queryParams);
         return this.client.processCall({
             url,
             requestOptions,
@@ -125,7 +125,7 @@ class BatchesApi extends sms_domain_api_1.SmsDomainApi {
             'Accept': 'application/json',
         };
         const body = '';
-        const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches`;
+        const basePathUrl = `${this.client.apiClientOptions.hostname}/xms/v1/${this.client.apiClientOptions.projectId}/batches`;
         const requestOptionsPromise = this.client.prepareOptions(basePathUrl, 'GET', getParams, headers, body || undefined);
         const operationProperties = {
             pagination: sdk_client_1.PaginationEnum.PAGE,
@@ -152,9 +152,9 @@ class BatchesApi extends sms_domain_api_1.SmsDomainApi {
             'Accept': 'application/json',
         };
         const body = data['replaceBatchMessageRequestBody'] ? JSON.stringify(data['replaceBatchMessageRequestBody']) : '{}';
-        const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
+        const basePathUrl = `${this.client.apiClientOptions.hostname}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
         const requestOptions = await this.client.prepareOptions(basePathUrl, 'PUT', getParams, headers, body || undefined);
-        const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
+        const url = this.client.prepareUrl(requestOptions.hostname, requestOptions.queryParams);
         return this.client.processCall({
             url,
             requestOptions,
@@ -179,9 +179,9 @@ class BatchesApi extends sms_domain_api_1.SmsDomainApi {
             'Accept': 'application/json',
         };
         const body = data['sendSMSRequestBody'] ? JSON.stringify(data['sendSMSRequestBody']) : '{}';
-        const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches`;
+        const basePathUrl = `${this.client.apiClientOptions.hostname}/xms/v1/${this.client.apiClientOptions.projectId}/batches`;
         const requestOptions = await this.client.prepareOptions(basePathUrl, 'POST', getParams, headers, body || undefined);
-        const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
+        const url = this.client.prepareUrl(requestOptions.hostname, requestOptions.queryParams);
         return this.client.processCall({
             url,
             requestOptions,
@@ -241,9 +241,9 @@ class BatchesApi extends sms_domain_api_1.SmsDomainApi {
             'Accept': 'application/json',
         };
         const body = data['updateBatchMessageRequestBody'] ? JSON.stringify(data['updateBatchMessageRequestBody']) : '{}';
-        const basePathUrl = `${this.client.apiClientOptions.basePath}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
+        const basePathUrl = `${this.client.apiClientOptions.hostname}/xms/v1/${this.client.apiClientOptions.projectId}/batches/${data['batch_id']}`;
         const requestOptions = await this.client.prepareOptions(basePathUrl, 'POST', getParams, headers, body || undefined);
-        const url = this.client.prepareUrl(requestOptions.basePath, requestOptions.queryParams);
+        const url = this.client.prepareUrl(requestOptions.hostname, requestOptions.queryParams);
         return this.client.processCall({
             url,
             requestOptions,