@sinch/sms 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +166 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +20 -0
- package/dist/index.js.map +1 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +18 -0
- package/dist/models/index.js.map +1 -0
- package/dist/models/v1/api-batch-list/api-batch-list.d.ts +17 -0
- package/dist/models/v1/api-batch-list/api-batch-list.js +9 -0
- package/dist/models/v1/api-batch-list/api-batch-list.js.map +1 -0
- package/dist/models/v1/api-batch-list/index.d.ts +1 -0
- package/dist/models/v1/api-batch-list/index.js +3 -0
- package/dist/models/v1/api-batch-list/index.js.map +1 -0
- package/dist/models/v1/api-batch-list-batches-inner/api-batch-list-batches-inner.d.ts +10 -0
- package/dist/models/v1/api-batch-list-batches-inner/api-batch-list-batches-inner.js +9 -0
- package/dist/models/v1/api-batch-list-batches-inner/api-batch-list-batches-inner.js.map +1 -0
- package/dist/models/v1/api-batch-list-batches-inner/index.d.ts +1 -0
- package/dist/models/v1/api-batch-list-batches-inner/index.js +3 -0
- package/dist/models/v1/api-batch-list-batches-inner/index.js.map +1 -0
- package/dist/models/v1/api-inbound-list/api-inbound-list.d.ts +17 -0
- package/dist/models/v1/api-inbound-list/api-inbound-list.js +9 -0
- package/dist/models/v1/api-inbound-list/api-inbound-list.js.map +1 -0
- package/dist/models/v1/api-inbound-list/index.d.ts +1 -0
- package/dist/models/v1/api-inbound-list/index.js +3 -0
- package/dist/models/v1/api-inbound-list/index.js.map +1 -0
- package/dist/models/v1/api-mo-message/api-mo-message.d.ts +27 -0
- package/dist/models/v1/api-mo-message/api-mo-message.js +9 -0
- package/dist/models/v1/api-mo-message/api-mo-message.js.map +1 -0
- package/dist/models/v1/api-mo-message/index.d.ts +1 -0
- package/dist/models/v1/api-mo-message/index.js +3 -0
- package/dist/models/v1/api-mo-message/index.js.map +1 -0
- package/dist/models/v1/api-update-binary-mt-message/api-update-binary-mt-message.d.ts +30 -0
- package/dist/models/v1/api-update-binary-mt-message/api-update-binary-mt-message.js +3 -0
- package/dist/models/v1/api-update-binary-mt-message/api-update-binary-mt-message.js.map +1 -0
- package/dist/models/v1/api-update-binary-mt-message/index.d.ts +1 -0
- package/dist/models/v1/api-update-binary-mt-message/index.js +3 -0
- package/dist/models/v1/api-update-binary-mt-message/index.js.map +1 -0
- package/dist/models/v1/api-update-mms-mt-message/api-update-mms-mt-message.d.ts +34 -0
- package/dist/models/v1/api-update-mms-mt-message/api-update-mms-mt-message.js +9 -0
- package/dist/models/v1/api-update-mms-mt-message/api-update-mms-mt-message.js.map +1 -0
- package/dist/models/v1/api-update-mms-mt-message/index.d.ts +1 -0
- package/dist/models/v1/api-update-mms-mt-message/index.js +3 -0
- package/dist/models/v1/api-update-mms-mt-message/index.js.map +1 -0
- package/dist/models/v1/api-update-mt-message/api-update-mt-message.d.ts +24 -0
- package/dist/models/v1/api-update-mt-message/api-update-mt-message.js +3 -0
- package/dist/models/v1/api-update-mt-message/api-update-mt-message.js.map +1 -0
- package/dist/models/v1/api-update-mt-message/index.d.ts +1 -0
- package/dist/models/v1/api-update-mt-message/index.js +3 -0
- package/dist/models/v1/api-update-mt-message/index.js.map +1 -0
- package/dist/models/v1/api-update-text-mt-message/api-update-text-mt-message.d.ts +31 -0
- package/dist/models/v1/api-update-text-mt-message/api-update-text-mt-message.js +9 -0
- package/dist/models/v1/api-update-text-mt-message/api-update-text-mt-message.js.map +1 -0
- package/dist/models/v1/api-update-text-mt-message/index.d.ts +1 -0
- package/dist/models/v1/api-update-text-mt-message/index.js +3 -0
- package/dist/models/v1/api-update-text-mt-message/index.js.map +1 -0
- package/dist/models/v1/binary-request/binary-request.d.ts +42 -0
- package/dist/models/v1/binary-request/binary-request.js +3 -0
- package/dist/models/v1/binary-request/binary-request.js.map +1 -0
- package/dist/models/v1/binary-request/index.d.ts +1 -0
- package/dist/models/v1/binary-request/index.js +3 -0
- package/dist/models/v1/binary-request/index.js.map +1 -0
- package/dist/models/v1/binary-response/binary-response.d.ts +50 -0
- package/dist/models/v1/binary-response/binary-response.js +3 -0
- package/dist/models/v1/binary-response/binary-response.js.map +1 -0
- package/dist/models/v1/binary-response/index.d.ts +1 -0
- package/dist/models/v1/binary-response/index.js +3 -0
- package/dist/models/v1/binary-response/index.js.map +1 -0
- package/dist/models/v1/create-group-request/create-group-request.d.ts +17 -0
- package/dist/models/v1/create-group-request/create-group-request.js +9 -0
- package/dist/models/v1/create-group-request/create-group-request.js.map +1 -0
- package/dist/models/v1/create-group-request/index.d.ts +1 -0
- package/dist/models/v1/create-group-request/index.js +3 -0
- package/dist/models/v1/create-group-request/index.js.map +1 -0
- package/dist/models/v1/create-group-response/create-group-response.d.ts +23 -0
- package/dist/models/v1/create-group-response/create-group-response.js +9 -0
- package/dist/models/v1/create-group-response/create-group-response.js.map +1 -0
- package/dist/models/v1/create-group-response/index.d.ts +4 -0
- package/dist/models/v1/create-group-response/index.js +3 -0
- package/dist/models/v1/create-group-response/index.js.map +1 -0
- package/dist/models/v1/delivery-feedback-request/delivery-feedback-request.d.ts +10 -0
- package/dist/models/v1/delivery-feedback-request/delivery-feedback-request.js +9 -0
- package/dist/models/v1/delivery-feedback-request/delivery-feedback-request.js.map +1 -0
- package/dist/models/v1/delivery-feedback-request/index.d.ts +1 -0
- package/dist/models/v1/delivery-feedback-request/index.js +3 -0
- package/dist/models/v1/delivery-feedback-request/index.js.map +1 -0
- package/dist/models/v1/delivery-report/delivery-report.d.ts +20 -0
- package/dist/models/v1/delivery-report/delivery-report.js +9 -0
- package/dist/models/v1/delivery-report/delivery-report.js.map +1 -0
- package/dist/models/v1/delivery-report/index.d.ts +1 -0
- package/dist/models/v1/delivery-report/index.js +3 -0
- package/dist/models/v1/delivery-report/index.js.map +1 -0
- package/dist/models/v1/delivery-report-list/delivery-report-list.d.ts +17 -0
- package/dist/models/v1/delivery-report-list/delivery-report-list.js +9 -0
- package/dist/models/v1/delivery-report-list/delivery-report-list.js.map +1 -0
- package/dist/models/v1/delivery-report-list/index.d.ts +1 -0
- package/dist/models/v1/delivery-report-list/index.js +3 -0
- package/dist/models/v1/delivery-report-list/index.js.map +1 -0
- package/dist/models/v1/dry-run-request/dry-run-request.d.ts +11 -0
- package/dist/models/v1/dry-run-request/dry-run-request.js +9 -0
- package/dist/models/v1/dry-run-request/dry-run-request.js.map +1 -0
- package/dist/models/v1/dry-run-request/index.d.ts +1 -0
- package/dist/models/v1/dry-run-request/index.js +3 -0
- package/dist/models/v1/dry-run-request/index.js.map +1 -0
- package/dist/models/v1/dry-run-response/dry-run-response.d.ts +15 -0
- package/dist/models/v1/dry-run-response/dry-run-response.js +9 -0
- package/dist/models/v1/dry-run-response/dry-run-response.js.map +1 -0
- package/dist/models/v1/dry-run-response/index.d.ts +1 -0
- package/dist/models/v1/dry-run-response/index.js +3 -0
- package/dist/models/v1/dry-run-response/index.js.map +1 -0
- package/dist/models/v1/dry-run-response-per-recipient-inner/dry-run-response-per-recipient-inner.d.ts +12 -0
- package/dist/models/v1/dry-run-response-per-recipient-inner/dry-run-response-per-recipient-inner.js +9 -0
- package/dist/models/v1/dry-run-response-per-recipient-inner/dry-run-response-per-recipient-inner.js.map +1 -0
- package/dist/models/v1/dry-run-response-per-recipient-inner/index.d.ts +1 -0
- package/dist/models/v1/dry-run-response-per-recipient-inner/index.js +3 -0
- package/dist/models/v1/dry-run-response-per-recipient-inner/index.js.map +1 -0
- package/dist/models/v1/enums.d.ts +15 -0
- package/dist/models/v1/enums.js +3 -0
- package/dist/models/v1/enums.js.map +1 -0
- package/dist/models/v1/error-response-obj/error-response-obj.d.ts +12 -0
- package/dist/models/v1/error-response-obj/error-response-obj.js +9 -0
- package/dist/models/v1/error-response-obj/error-response-obj.js.map +1 -0
- package/dist/models/v1/error-response-obj/index.d.ts +1 -0
- package/dist/models/v1/error-response-obj/index.js +3 -0
- package/dist/models/v1/error-response-obj/index.js.map +1 -0
- package/dist/models/v1/group-auto-update/group-auto-update.d.ts +12 -0
- package/dist/models/v1/group-auto-update/group-auto-update.js +9 -0
- package/dist/models/v1/group-auto-update/group-auto-update.js.map +1 -0
- package/dist/models/v1/group-auto-update/index.d.ts +1 -0
- package/dist/models/v1/group-auto-update/index.js +3 -0
- package/dist/models/v1/group-auto-update/index.js.map +1 -0
- package/dist/models/v1/group-object-auto-update/group-object-auto-update.d.ts +16 -0
- package/dist/models/v1/group-object-auto-update/group-object-auto-update.js +9 -0
- package/dist/models/v1/group-object-auto-update/group-object-auto-update.js.map +1 -0
- package/dist/models/v1/group-object-auto-update/index.d.ts +1 -0
- package/dist/models/v1/group-object-auto-update/index.js +3 -0
- package/dist/models/v1/group-object-auto-update/index.js.map +1 -0
- package/dist/models/v1/group-object-auto-update-remove/group-object-auto-update-remove.d.ts +19 -0
- package/dist/models/v1/group-object-auto-update-remove/group-object-auto-update-remove.js +14 -0
- package/dist/models/v1/group-object-auto-update-remove/group-object-auto-update-remove.js.map +1 -0
- package/dist/models/v1/group-object-auto-update-remove/index.d.ts +1 -0
- package/dist/models/v1/group-object-auto-update-remove/index.js +3 -0
- package/dist/models/v1/group-object-auto-update-remove/index.js.map +1 -0
- package/dist/models/v1/inbound-message-response/inbound-message-response.d.ts +9 -0
- package/dist/models/v1/inbound-message-response/inbound-message-response.js +9 -0
- package/dist/models/v1/inbound-message-response/inbound-message-response.js.map +1 -0
- package/dist/models/v1/inbound-message-response/index.d.ts +1 -0
- package/dist/models/v1/inbound-message-response/index.js +3 -0
- package/dist/models/v1/inbound-message-response/index.js.map +1 -0
- package/dist/models/v1/index.d.ts +45 -0
- package/dist/models/v1/index.js +62 -0
- package/dist/models/v1/index.js.map +1 -0
- package/dist/models/v1/list-groups-response/index.d.ts +1 -0
- package/dist/models/v1/list-groups-response/index.js +3 -0
- package/dist/models/v1/list-groups-response/index.js.map +1 -0
- package/dist/models/v1/list-groups-response/list-groups-response.d.ts +17 -0
- package/dist/models/v1/list-groups-response/list-groups-response.js +9 -0
- package/dist/models/v1/list-groups-response/list-groups-response.js.map +1 -0
- package/dist/models/v1/media-body/index.d.ts +1 -0
- package/dist/models/v1/media-body/index.js +3 -0
- package/dist/models/v1/media-body/index.js.map +1 -0
- package/dist/models/v1/media-body/media-body.d.ts +15 -0
- package/dist/models/v1/media-body/media-body.js +9 -0
- package/dist/models/v1/media-body/media-body.js.map +1 -0
- package/dist/models/v1/media-request/index.d.ts +1 -0
- package/dist/models/v1/media-request/index.js +3 -0
- package/dist/models/v1/media-request/index.js.map +1 -0
- package/dist/models/v1/media-request/media-request.d.ts +39 -0
- package/dist/models/v1/media-request/media-request.js +9 -0
- package/dist/models/v1/media-request/media-request.js.map +1 -0
- package/dist/models/v1/media-response/index.d.ts +1 -0
- package/dist/models/v1/media-response/index.js +3 -0
- package/dist/models/v1/media-response/index.js.map +1 -0
- package/dist/models/v1/media-response/media-response.d.ts +44 -0
- package/dist/models/v1/media-response/media-response.js +9 -0
- package/dist/models/v1/media-response/media-response.js.map +1 -0
- package/dist/models/v1/message-delivery-status/index.d.ts +1 -0
- package/dist/models/v1/message-delivery-status/index.js +3 -0
- package/dist/models/v1/message-delivery-status/index.js.map +1 -0
- package/dist/models/v1/message-delivery-status/message-delivery-status.d.ts +20 -0
- package/dist/models/v1/message-delivery-status/message-delivery-status.js +9 -0
- package/dist/models/v1/message-delivery-status/message-delivery-status.js.map +1 -0
- package/dist/models/v1/mo-binary/index.d.ts +1 -0
- package/dist/models/v1/mo-binary/index.js +3 -0
- package/dist/models/v1/mo-binary/index.js.map +1 -0
- package/dist/models/v1/mo-binary/mo-binary.d.ts +16 -0
- package/dist/models/v1/mo-binary/mo-binary.js +9 -0
- package/dist/models/v1/mo-binary/mo-binary.js.map +1 -0
- package/dist/models/v1/mo-text/index.d.ts +1 -0
- package/dist/models/v1/mo-text/index.js +3 -0
- package/dist/models/v1/mo-text/index.js.map +1 -0
- package/dist/models/v1/mo-text/mo-text.d.ts +13 -0
- package/dist/models/v1/mo-text/mo-text.js +9 -0
- package/dist/models/v1/mo-text/mo-text.js.map +1 -0
- package/dist/models/v1/parameter-obj/index.d.ts +1 -0
- package/dist/models/v1/parameter-obj/index.js +3 -0
- package/dist/models/v1/parameter-obj/index.js.map +1 -0
- package/dist/models/v1/parameter-obj/parameter-obj.d.ts +14 -0
- package/dist/models/v1/parameter-obj/parameter-obj.js +9 -0
- package/dist/models/v1/parameter-obj/parameter-obj.js.map +1 -0
- package/dist/models/v1/parameter-obj-parameter-key/index.d.ts +1 -0
- package/dist/models/v1/parameter-obj-parameter-key/index.js +3 -0
- package/dist/models/v1/parameter-obj-parameter-key/index.js.map +1 -0
- package/dist/models/v1/parameter-obj-parameter-key/parameter-obj-parameter-key.d.ts +15 -0
- package/dist/models/v1/parameter-obj-parameter-key/parameter-obj-parameter-key.js +9 -0
- package/dist/models/v1/parameter-obj-parameter-key/parameter-obj-parameter-key.js.map +1 -0
- package/dist/models/v1/recipient-delivery-report/index.d.ts +1 -0
- package/dist/models/v1/recipient-delivery-report/index.js +3 -0
- package/dist/models/v1/recipient-delivery-report/index.js.map +1 -0
- package/dist/models/v1/recipient-delivery-report/recipient-delivery-report.d.ts +35 -0
- package/dist/models/v1/recipient-delivery-report/recipient-delivery-report.js +3 -0
- package/dist/models/v1/recipient-delivery-report/recipient-delivery-report.js.map +1 -0
- package/dist/models/v1/replace-group-request/index.d.ts +1 -0
- package/dist/models/v1/replace-group-request/index.js +3 -0
- package/dist/models/v1/replace-group-request/index.js.map +1 -0
- package/dist/models/v1/replace-group-request/replace-group-request.d.ts +12 -0
- package/dist/models/v1/replace-group-request/replace-group-request.js +9 -0
- package/dist/models/v1/replace-group-request/replace-group-request.js.map +1 -0
- package/dist/models/v1/send-sms-request/index.d.ts +1 -0
- package/dist/models/v1/send-sms-request/index.js +3 -0
- package/dist/models/v1/send-sms-request/index.js.map +1 -0
- package/dist/models/v1/send-sms-request/send-sms-request.d.ts +10 -0
- package/dist/models/v1/send-sms-request/send-sms-request.js +9 -0
- package/dist/models/v1/send-sms-request/send-sms-request.js.map +1 -0
- package/dist/models/v1/send-sms-response/index.d.ts +1 -0
- package/dist/models/v1/send-sms-response/index.js +3 -0
- package/dist/models/v1/send-sms-response/index.js.map +1 -0
- package/dist/models/v1/send-sms-response/send-sms-response.d.ts +12 -0
- package/dist/models/v1/send-sms-response/send-sms-response.js +9 -0
- package/dist/models/v1/send-sms-response/send-sms-response.js.map +1 -0
- package/dist/models/v1/text-request/index.d.ts +1 -0
- package/dist/models/v1/text-request/index.js +3 -0
- package/dist/models/v1/text-request/index.js.map +1 -0
- package/dist/models/v1/text-request/text-request.d.ts +43 -0
- package/dist/models/v1/text-request/text-request.js +9 -0
- package/dist/models/v1/text-request/text-request.js.map +1 -0
- package/dist/models/v1/text-response/index.d.ts +1 -0
- package/dist/models/v1/text-response/index.js +3 -0
- package/dist/models/v1/text-response/index.js.map +1 -0
- package/dist/models/v1/text-response/text-response.d.ts +51 -0
- package/dist/models/v1/text-response/text-response.js +9 -0
- package/dist/models/v1/text-response/text-response.js.map +1 -0
- package/dist/models/v1/update-batch-message-request/index.d.ts +1 -0
- package/dist/models/v1/update-batch-message-request/index.js +3 -0
- package/dist/models/v1/update-batch-message-request/index.js.map +1 -0
- package/dist/models/v1/update-batch-message-request/update-batch-message-request.d.ts +10 -0
- package/dist/models/v1/update-batch-message-request/update-batch-message-request.js +9 -0
- package/dist/models/v1/update-batch-message-request/update-batch-message-request.js.map +1 -0
- package/dist/models/v1/update-group-request/index.d.ts +1 -0
- package/dist/models/v1/update-group-request/index.js +3 -0
- package/dist/models/v1/update-group-request/index.js.map +1 -0
- package/dist/models/v1/update-group-request/update-group-request.d.ts +21 -0
- package/dist/models/v1/update-group-request/update-group-request.js +9 -0
- package/dist/models/v1/update-group-request/update-group-request.js.map +1 -0
- package/dist/models/v1/update-group-request-auto-update/index.d.ts +1 -0
- package/dist/models/v1/update-group-request-auto-update/index.js +3 -0
- package/dist/models/v1/update-group-request-auto-update/index.js.map +1 -0
- package/dist/models/v1/update-group-request-auto-update/update-group-request-auto-update.d.ts +16 -0
- package/dist/models/v1/update-group-request-auto-update/update-group-request-auto-update.js +9 -0
- package/dist/models/v1/update-group-request-auto-update/update-group-request-auto-update.js.map +1 -0
- package/dist/models/v1/update-group-request-auto-update-add/index.d.ts +1 -0
- package/dist/models/v1/update-group-request-auto-update-add/index.js +3 -0
- package/dist/models/v1/update-group-request-auto-update-add/index.js.map +1 -0
- package/dist/models/v1/update-group-request-auto-update-add/update-group-request-auto-update-add.d.ts +16 -0
- package/dist/models/v1/update-group-request-auto-update-add/update-group-request-auto-update-add.js +14 -0
- package/dist/models/v1/update-group-request-auto-update-add/update-group-request-auto-update-add.js.map +1 -0
- package/dist/models/v1/update-group-request-auto-update-remove/index.d.ts +1 -0
- package/dist/models/v1/update-group-request-auto-update-remove/index.js +3 -0
- package/dist/models/v1/update-group-request-auto-update-remove/index.js.map +1 -0
- package/dist/models/v1/update-group-request-auto-update-remove/update-group-request-auto-update-remove.d.ts +19 -0
- package/dist/models/v1/update-group-request-auto-update-remove/update-group-request-auto-update-remove.js +14 -0
- package/dist/models/v1/update-group-request-auto-update-remove/update-group-request-auto-update-remove.js.map +1 -0
- package/dist/rest/index.d.ts +1 -0
- package/dist/rest/index.js +18 -0
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/v1/batches/batches-api.d.ts +114 -0
- package/dist/rest/v1/batches/batches-api.jest.fixture.d.ts +38 -0
- package/dist/rest/v1/batches/batches-api.jest.fixture.js +41 -0
- package/dist/rest/v1/batches/batches-api.jest.fixture.js.map +1 -0
- package/dist/rest/v1/batches/batches-api.js +213 -0
- package/dist/rest/v1/batches/batches-api.js.map +1 -0
- package/dist/rest/v1/batches/index.d.ts +1 -0
- package/dist/rest/v1/batches/index.js +18 -0
- package/dist/rest/v1/batches/index.js.map +1 -0
- package/dist/rest/v1/delivery-reports/delivery-reports-api.d.ts +63 -0
- package/dist/rest/v1/delivery-reports/delivery-reports-api.jest.fixture.d.ts +22 -0
- package/dist/rest/v1/delivery-reports/delivery-reports-api.jest.fixture.js +21 -0
- package/dist/rest/v1/delivery-reports/delivery-reports-api.jest.fixture.js.map +1 -0
- package/dist/rest/v1/delivery-reports/delivery-reports-api.js +94 -0
- package/dist/rest/v1/delivery-reports/delivery-reports-api.js.map +1 -0
- package/dist/rest/v1/delivery-reports/index.d.ts +1 -0
- package/dist/rest/v1/delivery-reports/index.js +18 -0
- package/dist/rest/v1/delivery-reports/index.js.map +1 -0
- package/dist/rest/v1/enums.d.ts +1 -0
- package/dist/rest/v1/enums.js +3 -0
- package/dist/rest/v1/enums.js.map +1 -0
- package/dist/rest/v1/fixtures.jest.d.ts +4 -0
- package/dist/rest/v1/fixtures.jest.js +12 -0
- package/dist/rest/v1/fixtures.jest.js.map +1 -0
- package/dist/rest/v1/groups/groups-api.d.ts +88 -0
- package/dist/rest/v1/groups/groups-api.jest.fixture.d.ts +34 -0
- package/dist/rest/v1/groups/groups-api.jest.fixture.js +37 -0
- package/dist/rest/v1/groups/groups-api.jest.fixture.js.map +1 -0
- package/dist/rest/v1/groups/groups-api.js +185 -0
- package/dist/rest/v1/groups/groups-api.js.map +1 -0
- package/dist/rest/v1/groups/index.d.ts +1 -0
- package/dist/rest/v1/groups/index.js +18 -0
- package/dist/rest/v1/groups/index.js.map +1 -0
- package/dist/rest/v1/inbounds/inbounds-api.d.ts +42 -0
- package/dist/rest/v1/inbounds/inbounds-api.jest.fixture.d.ts +16 -0
- package/dist/rest/v1/inbounds/inbounds-api.jest.fixture.js +17 -0
- package/dist/rest/v1/inbounds/inbounds-api.jest.fixture.js.map +1 -0
- package/dist/rest/v1/inbounds/inbounds-api.js +68 -0
- package/dist/rest/v1/inbounds/inbounds-api.js.map +1 -0
- package/dist/rest/v1/inbounds/index.d.ts +1 -0
- package/dist/rest/v1/inbounds/index.js +18 -0
- package/dist/rest/v1/inbounds/index.js.map +1 -0
- package/dist/rest/v1/index.d.ts +7 -0
- package/dist/rest/v1/index.js +24 -0
- package/dist/rest/v1/index.js.map +1 -0
- package/dist/rest/v1/sms-api.d.ts +26 -0
- package/dist/rest/v1/sms-api.js +89 -0
- package/dist/rest/v1/sms-api.js.map +1 -0
- package/dist/rest/v1/sms.d.ts +24 -0
- package/dist/rest/v1/sms.js +28 -0
- package/dist/rest/v1/sms.js.map +1 -0
- package/package.json +37 -0
package/README.md
ADDED
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# Sinch SMS SDK for Node.js
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
<span style="color:red; font-weight:bold">Warning:</span>
|
|
6
|
+
**This SDK is currently available for preview purposes only. It should not be used in production environments.**
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
We recommend to use this SDK as part of the `@sinch/sdk-core` package as it will take care about the authentication plugins to use.
|
|
11
|
+
|
|
12
|
+
However, it's still possible to use this SDK standalone is you need to access the SMS API only.
|
|
13
|
+
|
|
14
|
+
### With NPM
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install @sinch/sms
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### With Yarn
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
yarn add @sinch/sms
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
### Credentials
|
|
29
|
+
|
|
30
|
+
The `SMS` API uses the Sinch unified authentication with OAuth2 **for the US and EU regions only**. You will need to provide the following credentials:
|
|
31
|
+
- projectId: can be found in the [Account Dashboard](https://dashboard.sinch.com/settings/access-keys)
|
|
32
|
+
- keyId:: can be found in your Access key list in the [Account Dashboard](https://dashboard.sinch.com/settings/access-keys)
|
|
33
|
+
- keySecret: can be found **ONLY** when generating a new access key: keep it safe!
|
|
34
|
+
|
|
35
|
+
If you want to use the other regions (BR, AU or CA) or if you prefer to use this type of credential for US or EU, you can use the API Token authentication. You will need to provide the following credentials:
|
|
36
|
+
- servicePlanId: can be found in the SMS dashboard, under [Services Apis](https://dashboard.sinch.com/sms/api/services)
|
|
37
|
+
- apiToken: can be found in the SMS dashboard, under [Services Apis](https://dashboard.sinch.com/sms/api/services)
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### As part of the Sinch SDK
|
|
41
|
+
|
|
42
|
+
If you are using this SDK as part of the Sinch SDK (`@sinch/sdk-core`) you can access it as the `sms` property of the client that you would have instantiated.
|
|
43
|
+
|
|
44
|
+
```typescript
|
|
45
|
+
import {
|
|
46
|
+
SendSMSRequestData,
|
|
47
|
+
SendSMSResponse,
|
|
48
|
+
SinchClient,
|
|
49
|
+
SinchSmsClient,
|
|
50
|
+
SinchClientParameters,
|
|
51
|
+
Region,
|
|
52
|
+
} from '@sinch/sdk-core';
|
|
53
|
+
|
|
54
|
+
const credentialsWithProjectId: SinchClientParameters = {
|
|
55
|
+
projectId: 'PROJECT_ID',
|
|
56
|
+
keyId: 'KEY_ID',
|
|
57
|
+
keySecret: 'KEY_SECRET',
|
|
58
|
+
region: Region.UNITED_STATES, // Optional, default is 'us'. Only other possibility is 'eu'
|
|
59
|
+
};
|
|
60
|
+
const sinchWithProjectId = new SinchClient(credentialsWithProjectId);
|
|
61
|
+
|
|
62
|
+
const credentialsWithServicePlanId: SinchClientParameters = {
|
|
63
|
+
servicePlanId: 'SERVICE_PLAN_ID',
|
|
64
|
+
apiToken: 'API_TOKEN',
|
|
65
|
+
region: Region.UNITED_STATES, // Optional, default is 'us'. Other possibilities are 'eu', 'br', 'au' and 'ca'
|
|
66
|
+
};
|
|
67
|
+
const sinchWithServicePlanId = new SinchClient(credentialsWithServicePlanId);
|
|
68
|
+
|
|
69
|
+
const requestData: SendSMSRequestData = {
|
|
70
|
+
SendSMSRequest: {
|
|
71
|
+
to: [
|
|
72
|
+
'+12223334444',
|
|
73
|
+
'+12223335555'
|
|
74
|
+
],
|
|
75
|
+
from: '+12228889999',
|
|
76
|
+
parameters: {
|
|
77
|
+
name: {
|
|
78
|
+
'+12223334444': 'John',
|
|
79
|
+
default: 'there',
|
|
80
|
+
}
|
|
81
|
+
},
|
|
82
|
+
body: 'Hi ${name}',
|
|
83
|
+
type: 'mt_text',
|
|
84
|
+
},
|
|
85
|
+
};
|
|
86
|
+
|
|
87
|
+
// Access the 'sms' domain registered on the Sinch Client
|
|
88
|
+
// The request will be authenticated with OAuth2 and sent to https://zt.us.sms.api.sinch.com/xms/v1
|
|
89
|
+
const availabilityResult_1: SendSMSResponse
|
|
90
|
+
= await sinchWithProjectId.sms.batches.send(requestData);
|
|
91
|
+
|
|
92
|
+
// Access the 'sms' domain registered on the Sinch Client
|
|
93
|
+
// The request will be authenticated with the API Token and sent to https://us.sms.api.sinch.com/xms/v1
|
|
94
|
+
const availabilityResult_2: SendSMSResponse
|
|
95
|
+
= await sinchWithServicePlanId.sms.batches.send(requestData);
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Standalone
|
|
99
|
+
|
|
100
|
+
The SDK can be used standalone if you need to use only the SMS APIs. As for a usage with the Sinch Client, you can choose to use the `projectId` or `servicePlanId` credentials.
|
|
101
|
+
|
|
102
|
+
#### With the Oauth2TokenRequest plugin
|
|
103
|
+
|
|
104
|
+
```typescript
|
|
105
|
+
import {
|
|
106
|
+
Region,
|
|
107
|
+
SinchClientParameters,
|
|
108
|
+
} from '@sinch/sdk-client';
|
|
109
|
+
import {
|
|
110
|
+
SendSMSRequestData,
|
|
111
|
+
SendSMSResponse,
|
|
112
|
+
Sms,
|
|
113
|
+
} from '@sinch/sms';
|
|
114
|
+
|
|
115
|
+
const credentialsWithProjectId: SinchClientParameters = {
|
|
116
|
+
projectId: 'PROJECT_ID',
|
|
117
|
+
keyId: 'KEY_ID',
|
|
118
|
+
keySecret: 'KEY_SECRET',
|
|
119
|
+
region: Region.UNITED_STATES, // Optional, default is 'us'. Only other possibility is 'eu'
|
|
120
|
+
};
|
|
121
|
+
// Declare the 'sms' in a standalone way
|
|
122
|
+
const smsWithProjectId = new Sms(credentialsWithProjectId);
|
|
123
|
+
|
|
124
|
+
const credentialsWithServicePlanId: SinchClientParameters = {
|
|
125
|
+
servicePlanId: 'SERVICE_PLAN_ID',
|
|
126
|
+
apiToken: 'API_TOKEN',
|
|
127
|
+
region: Region.UNITED_STATES, // Optional, default is 'us'. Other possibilities are 'eu', 'br', 'au' and 'ca'
|
|
128
|
+
};
|
|
129
|
+
// Declare the 'sms' in a standalone way
|
|
130
|
+
const smsWithServicePlanId = new Sms(credentialsWithServicePlanId);
|
|
131
|
+
|
|
132
|
+
const requestData: SendSMSRequestData = {
|
|
133
|
+
// some request parameters
|
|
134
|
+
};
|
|
135
|
+
|
|
136
|
+
// Use the standalone declaration of the 'sms' domain
|
|
137
|
+
// The request will be authenticated with OAuth2 and sent to https://zt.us.sms.api.sinch.com/xms/v1
|
|
138
|
+
const response_1: SendSMSResponse = await smsWithProjectId.batches.send(requestData);
|
|
139
|
+
|
|
140
|
+
// Use the standalone declaration of the 'sms' domain
|
|
141
|
+
// The request will be authenticated with the API Token and sent to https://us.sms.api.sinch.com/xms/v1
|
|
142
|
+
const response_2: SendSMSResponse = await smsWithServicePlanId.batches.send(requestData);
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Promises
|
|
146
|
+
|
|
147
|
+
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()`.
|
|
148
|
+
|
|
149
|
+
```typescript
|
|
150
|
+
// Method 1: Wait for the Promise to complete
|
|
151
|
+
let response: SendSMSResponse;
|
|
152
|
+
try {
|
|
153
|
+
response = await sinch.sms.batches.send(requestData);
|
|
154
|
+
console.log(`The SMS has been sent successfully: batch id = ${response.id}`);
|
|
155
|
+
} catch (error: any) {
|
|
156
|
+
console.error(`ERROR ${error.statusCode}: the SMS could not be sent`);
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
// Method 2: Resolve the promise
|
|
160
|
+
sinch.sms.batches.send(requestData)
|
|
161
|
+
.then(response => console.log(`The SMS has been sent successfully: batch id = ${response.id}`))
|
|
162
|
+
.catch(error => console.error(`ERROR ${error.statusCode}: the SMS could not be sent`));
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
## Contact
|
|
166
|
+
Developer Experience team: [devexp@sinch.com](mailto:devexp@sinch.com)
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./models"), exports);
|
|
18
|
+
__exportStar(require("./rest"), exports);
|
|
19
|
+
__exportStar(require("@sinch/sdk-client"), exports);
|
|
20
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,yCAAuB;AACvB,oDAAkC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './v1';
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./v1"), exports);
|
|
18
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uCAAqB"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Model: ApiBatchList
|
|
3
|
+
*
|
|
4
|
+
* THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
|
|
5
|
+
*
|
|
6
|
+
*/
|
|
7
|
+
import { ApiBatchListBatchesInner } from '../api-batch-list-batches-inner';
|
|
8
|
+
export interface ApiBatchList {
|
|
9
|
+
/** The total number of entries matching the given filters. */
|
|
10
|
+
count?: number;
|
|
11
|
+
/** The requested page. */
|
|
12
|
+
page?: number;
|
|
13
|
+
/** The page of batches matching the given filters. */
|
|
14
|
+
batches?: ApiBatchListBatchesInner[];
|
|
15
|
+
/** The number of entries returned in this request. */
|
|
16
|
+
page_size?: number;
|
|
17
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-batch-list.js","sourceRoot":"","sources":["../../../../src/models/v1/api-batch-list/api-batch-list.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { ApiBatchList } from './api-batch-list';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/api-batch-list/index.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Model: ApiBatchListBatchesInner
|
|
3
|
+
*
|
|
4
|
+
* THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
|
|
5
|
+
*
|
|
6
|
+
*/
|
|
7
|
+
import { BinaryResponse } from '../binary-response';
|
|
8
|
+
import { MediaResponse } from '../media-response';
|
|
9
|
+
import { TextResponse } from '../text-response';
|
|
10
|
+
export type ApiBatchListBatchesInner = BinaryResponse | MediaResponse | TextResponse;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-batch-list-batches-inner.js","sourceRoot":"","sources":["../../../../src/models/v1/api-batch-list-batches-inner/api-batch-list-batches-inner.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { ApiBatchListBatchesInner } from './api-batch-list-batches-inner';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/api-batch-list-batches-inner/index.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Model: ApiInboundList
|
|
3
|
+
*
|
|
4
|
+
* THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
|
|
5
|
+
*
|
|
6
|
+
*/
|
|
7
|
+
import { InboundMessageResponse } from '../inbound-message-response';
|
|
8
|
+
export interface ApiInboundList {
|
|
9
|
+
/** The total number of inbounds matching the given filters */
|
|
10
|
+
count?: number;
|
|
11
|
+
/** The requested page. */
|
|
12
|
+
page?: number;
|
|
13
|
+
/** The page of inbounds matching the given filters. */
|
|
14
|
+
inbounds?: InboundMessageResponse[];
|
|
15
|
+
/** The number of inbounds returned in this request. */
|
|
16
|
+
page_size?: number;
|
|
17
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-inbound-list.js","sourceRoot":"","sources":["../../../../src/models/v1/api-inbound-list/api-inbound-list.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { ApiInboundList } from './api-inbound-list';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/api-inbound-list/index.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Model: ApiMoMessage
|
|
3
|
+
*
|
|
4
|
+
* THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
|
|
5
|
+
*
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* The page of inbounds matching the given filters.
|
|
9
|
+
*/
|
|
10
|
+
export interface ApiMoMessage {
|
|
11
|
+
body?: string;
|
|
12
|
+
/** 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. */
|
|
13
|
+
client_reference?: string;
|
|
14
|
+
/** The phone number that sent the message. <a href=\"https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628\" target=\"_blank\">More info</a> */
|
|
15
|
+
from: string;
|
|
16
|
+
/** The ID of this inbound message. */
|
|
17
|
+
id: string;
|
|
18
|
+
/** The MCC/MNC of the sender\'s operator if known. */
|
|
19
|
+
operator_id?: string;
|
|
20
|
+
/** 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`. */
|
|
21
|
+
received_at: Date;
|
|
22
|
+
/** 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`. */
|
|
23
|
+
sent_at?: Date;
|
|
24
|
+
/** The Sinch phone number or short code to which the message was sent. */
|
|
25
|
+
to: string;
|
|
26
|
+
type: string;
|
|
27
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-mo-message.js","sourceRoot":"","sources":["../../../../src/models/v1/api-mo-message/api-mo-message.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { ApiMoMessage } from './api-mo-message';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/api-mo-message/index.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Model: ApiUpdateBinaryMtMessage
|
|
3
|
+
*
|
|
4
|
+
* THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
|
|
5
|
+
*
|
|
6
|
+
*/
|
|
7
|
+
import { DeliveryReportEnum } from '../enums';
|
|
8
|
+
export interface ApiUpdateBinaryMtMessage {
|
|
9
|
+
/** Sender number. Must be valid phone number, short code or alphanumeric. */
|
|
10
|
+
from?: string;
|
|
11
|
+
/** SMS in binary format */
|
|
12
|
+
type?: TypeEnum;
|
|
13
|
+
/** List of phone numbers and group IDs to add to the batch. */
|
|
14
|
+
to_add?: string[];
|
|
15
|
+
/** List of phone numbers and group IDs to remove from the batch. */
|
|
16
|
+
to_remove?: string[];
|
|
17
|
+
/** Request delivery report callback. Note that delivery reports can be fetched from the API regardless of this setting. */
|
|
18
|
+
delivery_report?: DeliveryReportEnum;
|
|
19
|
+
/** 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. */
|
|
20
|
+
send_at?: Date;
|
|
21
|
+
/** 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` */
|
|
22
|
+
expire_at?: Date;
|
|
23
|
+
/** Override the default callback URL for this batch. Constraints: Must be valid URL. */
|
|
24
|
+
callback_url?: string;
|
|
25
|
+
/** The message content Base64 encoded. Max 140 bytes together with udh. */
|
|
26
|
+
body?: string;
|
|
27
|
+
/** The UDH header of a binary message HEX encoded. Max 140 bytes together with body. */
|
|
28
|
+
udh?: string;
|
|
29
|
+
}
|
|
30
|
+
export type TypeEnum = 'mt_binary';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-update-binary-mt-message.js","sourceRoot":"","sources":["../../../../src/models/v1/api-update-binary-mt-message/api-update-binary-mt-message.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { ApiUpdateBinaryMtMessage } from './api-update-binary-mt-message';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/api-update-binary-mt-message/index.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Model: ApiUpdateMmsMtMessage
|
|
3
|
+
*
|
|
4
|
+
* THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
|
|
5
|
+
*
|
|
6
|
+
*/
|
|
7
|
+
import { MediaBody } from '../media-body';
|
|
8
|
+
import { ParameterObj } from '../parameter-obj';
|
|
9
|
+
import { DeliveryReportEnum } from '../enums';
|
|
10
|
+
export interface ApiUpdateMmsMtMessage {
|
|
11
|
+
/** Sender number. Must be valid phone number, short code or alphanumeric. */
|
|
12
|
+
from?: string;
|
|
13
|
+
/** MMS */
|
|
14
|
+
type?: TypeEnum;
|
|
15
|
+
/** List of phone numbers and group IDs to add to the batch. */
|
|
16
|
+
to_add?: string[];
|
|
17
|
+
/** List of phone numbers and group IDs to remove from the batch. */
|
|
18
|
+
to_remove?: string[];
|
|
19
|
+
/** Request delivery report callback. Note that delivery reports can be fetched from the API regardless of this setting. */
|
|
20
|
+
delivery_report?: DeliveryReportEnum;
|
|
21
|
+
/** 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. */
|
|
22
|
+
send_at?: Date;
|
|
23
|
+
/** 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` */
|
|
24
|
+
expire_at?: Date;
|
|
25
|
+
/** Override the default callback URL for this batch. Constraints: Must be valid URL. */
|
|
26
|
+
callback_url?: string;
|
|
27
|
+
/** @see MediaBody */
|
|
28
|
+
body?: MediaBody;
|
|
29
|
+
/** @see ParameterObj */
|
|
30
|
+
parameters?: ParameterObj;
|
|
31
|
+
/** 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. */
|
|
32
|
+
strict_validation?: boolean;
|
|
33
|
+
}
|
|
34
|
+
export type TypeEnum = 'mt_media';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-update-mms-mt-message.js","sourceRoot":"","sources":["../../../../src/models/v1/api-update-mms-mt-message/api-update-mms-mt-message.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { ApiUpdateMmsMtMessage } from './api-update-mms-mt-message';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/api-update-mms-mt-message/index.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Model: ApiUpdateMtMessage
|
|
3
|
+
*
|
|
4
|
+
* THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
|
|
5
|
+
*
|
|
6
|
+
*/
|
|
7
|
+
import { DeliveryReportEnum } from '../enums';
|
|
8
|
+
export interface ApiUpdateMtMessage {
|
|
9
|
+
/** Sender number. Must be valid phone number, short code or alphanumeric. */
|
|
10
|
+
from?: string;
|
|
11
|
+
type?: string;
|
|
12
|
+
/** List of phone numbers and group IDs to add to the batch. */
|
|
13
|
+
to_add?: string[];
|
|
14
|
+
/** List of phone numbers and group IDs to remove from the batch. */
|
|
15
|
+
to_remove?: string[];
|
|
16
|
+
/** Request delivery report callback. Note that delivery reports can be fetched from the API regardless of this setting. */
|
|
17
|
+
delivery_report?: DeliveryReportEnum;
|
|
18
|
+
/** 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. */
|
|
19
|
+
send_at?: Date;
|
|
20
|
+
/** 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` */
|
|
21
|
+
expire_at?: Date;
|
|
22
|
+
/** Override the default callback URL for this batch. Constraints: Must be valid URL. */
|
|
23
|
+
callback_url?: string;
|
|
24
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-update-mt-message.js","sourceRoot":"","sources":["../../../../src/models/v1/api-update-mt-message/api-update-mt-message.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { ApiUpdateMtMessage } from './api-update-mt-message';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/api-update-mt-message/index.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Model: ApiUpdateTextMtMessage
|
|
3
|
+
*
|
|
4
|
+
* THIS FILE HAS BEEN AUTOMATICALLY GENERATED. DO NOT EDIT.
|
|
5
|
+
*
|
|
6
|
+
*/
|
|
7
|
+
import { ParameterObj } from '../parameter-obj';
|
|
8
|
+
import { DeliveryReportEnum } from '../enums';
|
|
9
|
+
export interface ApiUpdateTextMtMessage {
|
|
10
|
+
/** Sender number. Must be valid phone number, short code or alphanumeric. */
|
|
11
|
+
from?: string;
|
|
12
|
+
/** Regular SMS */
|
|
13
|
+
type?: TypeEnum;
|
|
14
|
+
/** List of phone numbers and group IDs to add to the batch. */
|
|
15
|
+
to_add?: string[];
|
|
16
|
+
/** List of phone numbers and group IDs to remove from the batch. */
|
|
17
|
+
to_remove?: string[];
|
|
18
|
+
/** Request delivery report callback. Note that delivery reports can be fetched from the API regardless of this setting. */
|
|
19
|
+
delivery_report?: DeliveryReportEnum;
|
|
20
|
+
/** 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. */
|
|
21
|
+
send_at?: Date;
|
|
22
|
+
/** 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` */
|
|
23
|
+
expire_at?: Date;
|
|
24
|
+
/** Override the default callback URL for this batch. Constraints: Must be valid URL. */
|
|
25
|
+
callback_url?: string;
|
|
26
|
+
/** @see ParameterObj */
|
|
27
|
+
parameters?: ParameterObj;
|
|
28
|
+
/** The message content */
|
|
29
|
+
body?: string;
|
|
30
|
+
}
|
|
31
|
+
export type TypeEnum = 'mt_text' | 'mt_binary' | 'mt_media';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-update-text-mt-message.js","sourceRoot":"","sources":["../../../../src/models/v1/api-update-text-mt-message/api-update-text-mt-message.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { ApiUpdateTextMtMessage } from './api-update-text-mt-message';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/api-update-text-mt-message/index.ts"],"names":[],"mappings":""}
|