plivo 4.16.0 → 4.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 432a8633325d5e44eee995dc40993c24b25251ae
-  data.tar.gz: f1c57049cd472b7f27912e15c34949e560994132
+  metadata.gz: dcdea3382ce47522a95bff0850bcc67a582ebb54
+  data.tar.gz: 77652b31e99304dc2166f94fa9e7b5384d0c5fe6
 SHA512:
-  metadata.gz: eef8a0013b8f4eb0356c98bf70c6390b0be26b23bfc6236b78751df0d8c3496a29d0f556361a5068225beda650b6d8385cd95927c05bac3cc37fb761e635ed11
-  data.tar.gz: f2a93d08156446bfe73769f162c8bd8ade2d20314cadf636b8831ea91b02de673965638b3e0aea385d2c9a7dd5527b91432295c379ad88bfc16365a2d49a029a
+  metadata.gz: dda1d4228d6a950a364da677d7fc561a090e79cf83991c4a14659bf1f37f56229c029fd3f12a1f0e8e6dfc3d3a38237d54dca200095c0e7873025d924285e9ec
+  data.tar.gz: e7e0832bb62f63262843787afc5a2107474c4e1133e3ef8b6cb088b8e0d32b15eb3de8afa2731b243af720fc26a908946539051140f8f134f9516c5027d130d1

data/.github/workflows/unitTests.yml

@@ -0,0 +1,32 @@
+name: UnitTest
+
+on:
+  push:
+    branches: [ unitTests ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: UnitTest
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+         ruby-version: [ '2.6' ,'2.7', '3.0' ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Dependencies Installation
+        run: |
+          bundle install --without development
+      - name: Run Tests
+        run: |
+          ruby --version
+          bundle exec rake
+          rm Gemfile.lock
+  

data/.gitignore

@@ -12,3 +12,4 @@ tmp/
 bin/
 # rspec failure tracking
 .rspec_status
+ruby-sdk-test/

data/CHANGELOG.md

@@ -1,5 +1,230 @@
 # Change Log
 
+## [4.58.0](https://github.com/plivo/plivo-ruby/tree/v4.58.0) (2023-05-17)
+**Feature - Adding support for location whatsapp messages**
+- Added new param `location` to [send message API](https://www.plivo.com/docs/sms/api/message#send-a-message) to support location `whatsapp` messages
+- Added new param `location` in templates to support location based templated messages
+
+## [4.57.0](https://github.com/plivo/plivo-ruby/tree/v4.57.0) (2023-05-07)
+**Feature - Adding support for interactive whatsapp messages**
+- Added new param `interactive` to [send message API](https://www.plivo.com/docs/sms/api/message#send-a-message) to support interactive `whatsapp` messages
+
+## [4.56.0](https://github.com/plivo/plivo-ruby/tree/v4.56.0) (2023-04-18)
+**Feature - Support for dynamic button components when sending a templated WhatsApp message**
+- Added new param `payload` in templates to support dynamic payload in templates
+
+## [4.55.2](https://github.com/plivo/plivo-ruby/tree/v4.55.2) (2024-02-28)
+**Feature - Log Redaction Enhancement**
+-  Added log attribute in GET and List MDR response
+-  Change log field from bool to string in send SMS
+
+## [4.55.1](https://github.com/plivo/plivo-ruby/tree/v4.55.1) (2024-01-08)
+**Feature - Added New Param 'type' for Speak Api**
+- Added new param "type" for speak api
+
+## [4.55.0](https://github.com/plivo/plivo-ruby/tree/v4.55.0) (2023-11-20)
+**Feature - Added New Param 'registration_status' for Campaign List**
+- Added new query param "registration_status" for campaign list
+
+## [4.54.0](https://github.com/plivo/plivo-ruby/tree/v4.54.0) (2023-11-17)
+**Feature - Verify Caller Id API support**
+- API support for verifying, updating, getting and deleting caller IDs.
+
+## [4.53.1](https://github.com/plivo/plivo-ruby/tree/v4.53.1) (2023-11-09)
+**Feature - Verify Service**
+-Added Support for Verify Service Public API
+-Create Session API : To create a verify session. Allowed params recipient, method, channel, callback_url, app_uuid
+-Get Session API: To retrieve a particular session
+-List Sessions : To retrieve all the sessions
+-Validate Session : To validate OTP for a particular session
+
+## [4.52.0](https://github.com/plivo/plivo-ruby/tree/v4.52.0) (2023-11-08)
+**[BETA] Feature - TollFree Verification API Support**
+- API support for Create, Update, Get, Delete, and List Tollfree Verification.
+- Added New Param `toll_free_sms_verification_id` and `toll_free_sms_verification_order_status` in to the response of the [list all numbers API], [list single number API]
+- Added `toll_free_sms_verification_order_status` filter to AccountPhoneNumber - list all my numbers API.
+
+## [4.51.0](https://github.com/plivo/plivo-ruby/tree/v4.51.0) (2023-10-16)
+**Introducing campaign_source & import partner camapign API**
+- New field campaign_source introduced
+- Import partner campaign API added
+
+## [4.50.0](https://github.com/plivo/plivo-ruby/tree/v4.50.0) (2023-10-13)
+**Feature - WhatsApp message support**
+- Added new params `template` and new message_type `whatsapp` to [send message API](https://www.plivo.com/docs/sms/api/message#send-a-message)
+- Added  new  `message_state` (`read`), `message_type`(`whatsapp`), `conversation_id`, `conversation_origin`, `conversation_expiration_timestamp` in [list all messages API](https://www.plivo.com/docs/sms/api/message#list-all-messages) and [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message) response
+
+## [4.49.0](https://github.com/plivo/plivo-ruby/tree/v4.49.0) (2023-09-13)
+**Removing the faraday_middleware dependency and upgrade to farady latest version
+
+## [4.48.0](https://github.com/plivo/plivo-ruby/tree/v4.48.0) (2023-08-25)
+**Feature - Added New Param 'carrier_fees', 'carrier_fees_rate', 'destination_network' in Get Message and List Message APIs**
+- Added new params on message get and list response
+
+
+## [4.47.0](https://github.com/plivo/plivo-ruby/tree/v4.47.0) (2023-08-03)
+**Feature - DLT parameters**
+- Added new params `DLTEntityID`, `DLTTemplateID`, `DLTTemplateCategory` to the [send message API](https://www.plivo.com/docs/sms/api/message/send-a-message/)
+- Added new params `DLTEntityID`, `DLTTemplateID`, `DLTTemplateCategory` to the response for the [list all messages API](https://www.plivo.com/docs/sms/api/message/list-all-messages/) and the [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message)
+
+## [4.46.0](https://github.com/plivo/plivo-ruby/tree/v4.46.0) (2023-06-28)
+**Feature - Audio Streaming**
+- Added functionality to start, stop and fetch audio streams
+- Added functionality to create stream XML
+
+## [4.45.0](https://github.com/plivo/plivo-ruby/tree/v4.45.0) (2023-05-02)
+**Feature - CNAM Lookup**
+- Added New Param `cnam_lookup` in to the response of the [list all numbers API], [list single number API]
+- Added `cnam_lookup` filter to AccountPhoneNumber - list all my numbers API.
+- Added `cnam_lookup` parameter to buy number[Buy a Phone Number]  to configure CNAM Lookup while buying a US number
+- Added `cnam_lookup` parameter to update number[Update an account phone number] to configure CNAM Lookup while buying a US number
+
+
+## [4.44.0](https://github.com/plivo/plivo-ruby/tree/v4.38.2) (2023-03-16)
+**Feature : Added new param in getCallDetail api**
+- From now on we can see CNAM(Caller_id name) details at CDR level.
+
+## [4.43.0](https://github.com/plivo/plivo-ruby/tree/v4.43.0) (2023-05-29)
+**Feature - Recording API changes**
+- Added `monthly_recording_storage_amount`, `recording_storage_rate`, `rounded_recording_duration`, and `recording_storage_duration` parameters to the response for [get single recording API](https://www.plivo.com/docs/voice/api/recording#retrieve-a-recording) and [get all recordings API](https://www.plivo.com/docs/voice/api/recording#list-all-recordings)
+- Added `recording_storage_duration` parameter as a filter option for [get all recordings API](https://www.plivo.com/docs/voice/api/recording#list-all-recordings)
+
+## [4.42.0](https://github.com/plivo/plivo-ruby/tree/v4.42.0) (2023-05-04)
+**Adding new attribute - 'renewalDate' in Get Number and List Number APIs**
+- Add New Param `renewalDate` to the response of the [list all numbers API], [list single number API]
+- Add 3 new filters to AccountPhoneNumber - list all my numbers API:`renewal_date`, `renewal_date__gt`, `renewal_date__gte`,`renewal_date__lt` and `renewal_date__lte` (https://www.plivo.com/docs/numbers/api/account-phone-number#list-all-my-numbers)
+
+## [4.41.0](https://github.com/plivo/plivo-ruby/tree/v4.41.0) (2023-04-25)
+**Adding new attribute - 'replaced_sender' in Get Message and List Message APIs**
+- Add `replaced_sender` to the response for the [list all messages API](https://www.plivo.com/docs/sms/api/message/list-all-messages/) and the [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message)
+
+## [4.40.0](https://github.com/plivo/plivo-ruby/tree/v4.37.0) (2023-04-11)
+**Feature - Added New Param 'source_ip' in GetCall and ListCalls**
+- Add `source_ip` to the response for the [retrieve a call details API](https://www.plivo.com/docs/voice/api/call#retrieve-a-call) and the [retreive all call details API](https://www.plivo.com/docs/voice/api/call#retrieve-all-calls)
+
+## [4.39.0](https://github.com/plivo/plivo-ruby/tree/v4.39.0) (2023-03-17)
+**Adding new attribute - 'created_at' in List Profiles, Get Profile, List Brands, Get Brand, List Campaigns and Get Campaign APIs**
+- dding new attribute - 'created_at' in List Profiles, Get Profile, List Brands, Get Brand, List Campaigns and Get Campaign APIs
+
+## [4.38.1](https://github.com/plivo/plivo-ruby/tree/v4.38.1) (2023-03-06)
+**Bug fix on create message**
+- Bulk send message fix
+
+## [4.38.0](https://github.com/plivo/plivo-ruby/tree/v4.38.0) (2023-03-03)
+**Adding new attribute - 'is_domestic' in Get Message and List Message APIs**
+- Add `is_domestic` to the response for the [list all messages API](https://www.plivo.com/docs/sms/api/message/list-all-messages/) and the [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message)
+
+## [4.37.1](https://github.com/plivo/plivo-ruby/tree/v4.37.1) (2023-02-23)
+**Bug fix on Messaging object **
+- 
+## [4.37.0](https://github.com/plivo/plivo-ruby/tree/v4.37.0) (2023-02-23)
+**Feature - Enhance MDR filtering capabilities **
+- Added new fields on MDR object response
+
+## [4.37.0](https://github.com/plivo/plivo-ruby/tree/v4.37.0) (2023-02-06)
+**Feature - Added New Param 'source_ip' in GetCall and ListCalls**
+- Add `source_ip` to the response for the [retrieve a call details API](https://www.plivo.com/docs/voice/api/call#retrieve-a-call) and the [retreive all call details API](https://www.plivo.com/docs/voice/api/call#retrieve-all-calls)
+
+## [4.36.0](https://github.com/plivo/plivo-ruby/tree/v4.36.0) (2022-01-25)
+**Adding new attribute - 'requester_ip' in Get Message and List Mssage APIs**
+- Add `requester_ip` to the response for the [list all messages API](https://www.plivo.com/docs/sms/api/message/list-all-messages/) and the [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message)
+
+## [4.35.0](https://github.com/plivo/plivo-ruby/tree/v4.35.0) (2022-01-18)
+**Adding new attribute - 'message_expiry' in Send Message API**
+- Added new attribute - message_expiry in Send Message API
+
+## [4.34.0](https://github.com/plivo/plivo-ruby/tree/v4.34.0) (2022-12-16)
+**10DLC: Update Campaign API**
+- Added Update Campaign API
+
+## [4.33.0](https://github.com/plivo/plivo-ruby/tree/v4.33.0) (2022-12-06)
+**10DLC: Delete Campaign and Brand API**
+- Added Delete campaign and brand API
+
+## [4.32.0](https://github.com/plivo/plivo-ruby/tree/v4.32.0) (2022-11-03)
+**10DLC: Brand Usecase API**
+- Added Brand Usecase API
+
+## [4.31.0](https://github.com/plivo/plivo-ruby/tree/v4.31.0) (2022-10-14)
+**Adding new attributes to Account PhoneNumber object**
+-Added 3 new keys to AccountPhoneNumber object:`tendlc_registration_status`, `tendlc_campaign_id` and `toll_free_sms_verification` (https://www.plivo.com/docs/numbers/api/account-phone-number#the-accountphonenumber-object)
+-Added 3 new filters to AccountPhoneNumber - list all my numbers API:`tendlc_registration_status`, `tendlc_campaign_id` and `toll_free_sms_verification` (https://www.plivo.com/docs/numbers/api/account-phone-number#list-all-my-numbers)
+
+## [4.30.2](https://github.com/plivo/plivo-ruby/tree/v4.30.2) (2022-09-28)
+**10DLC: Campaign request**
+- Added more attributes to create campaign request
+
+## [4.30.1](https://github.com/plivo/plivo-ruby/tree/v4.30.1) (2022-09-20)
+**stability - faraday upgrade**
+- faraday version upgrade
+
+## [4.30.0](https://github.com/plivo/plivo-ruby/tree/v4.30.0) (2022-08-26)
+**Feature - 10DLC APIs**
+- Added new 10DLC APIs
+
+## [4.29.0](https://github.com/plivo/plivo-ruby/tree/v4.29.0) (2022-08-01)
+**Feature - Token Creation**
+- `JWT Token Creation API` added functionality to create a new JWT token.
+
+## [4.28.0](https://github.com/plivo/plivo-ruby/tree/v4.28.0) (2022-07-11)
+**Feature - STIR Attestation**
+- Add stir attestation param as part of Get CDR and Get live call APIs Response
+
+## [4.27.1](https://github.com/plivo/plivo-ruby/tree/v4.27.1) (2022-06-30)
+- `from_number`, `to_number` and `stir_verification` added to filter param [Retrieve all calls] (https://www.plivo.com/docs/voice/api/call#retrieve-all-calls)
+
+## [4.27.0](https://github.com/plivo/plivo-ruby/tree/v4.27.0) (2022-05-05)
+**Feature - List all recordings**
+- `from_number` and `to_number` added to filter param [List all recordings](https://www.plivo.com/docs/voice/api/recording#list-all-recordings)
+- `record_min_member_count` param added to [Add a participant to a multiparty call using API](https://www.plivo.com/docs/voice/api/multiparty-call/participants#add-a-participant)
+
+## [4.26.0](https://github.com/plivo/plivo-ruby/tree/v4.26.0) (2022-03-24)
+**Feature - DialElement**
+- `confirmTimeout` parameter added to [The Dial element](https://www.plivo.com/docs/voice/xml/dial/)
+
+## [4.25.1](https://github.com/plivo/plivo-ruby/tree/v4.25.1) (2022-02-02)
+**Bugfix - Recording**
+- Fix for Start Recording API response issue
+
+## [4.25.0](https://github.com/plivo/plivo-ruby/tree/v4.25.0) (2022-01-27)
+**Features - MPCStartCallRecording**
+- parameter name change from statusCallback to recordingCallback
+
+## [4.24.0](https://github.com/plivo/plivo-ruby/tree/v4.24.0) (2021-12-14)
+**Features - Voice**
+- Routing SDK traffic through Akamai endpoints for all the [Voice APIs](https://www.plivo.com/docs/voice/api/overview/)
+
+## [4.23.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.23.0) (2021-12-02)
+**Features - Messaging: 10 DLC**
+- 10DLC API's for brand and campaign support.
+
+## [4.22.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.22.0) (2021-11-11)
+**Features - Voice: Multiparty call**
+- The [Add Multiparty Call API](https://www.plivo.com/docs/voice/api/multiparty-call/participants#add-a-participant) allows for greater functionality by accepting options like `start recording audio`, `stop recording audio`, and their HTTP methods.
+- [Multiparty Calls](https://www.plivo.com/docs/voice/api/multiparty-call/) now has new APIs to `stop` and `play` audio.
+
+## [4.21.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.21.0) (2021-10-11)
+**Features - Messaging**
+- This version includes advancements to the Messaging Interface that deals with the [Send SMS/MMS](https://www.plivo.com/docs/sms/api/message#send-a-message) interface, Creating a standard structure for `request/input` arguments to make implementation easier and incorporating support for the older interface.
+
+  Example for [send SMS](https://github.com/plivo/plivo-ruby#send-a-message)
+
+## [4.20.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.20.0) (2021-08-04)
+- Added continue speak XML element support.
+
+## [4.19.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.19.0) (2021-07-19)
+- Add support for Voice MultiPartyCall APIs (includes retry) and XML, validate voice UTs
+
+## [4.18.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.18.0) (2021-07-13)
+- Power pack ID has been included to the response for the [list all messages API](https://www.plivo.com/docs/sms/api/message/list-all-messages/) and the [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message).
+- Support for filtering messages by Power pack ID has been added to the [list all messages API](https://www.plivo.com/docs/sms/api/message#list-all-messages).
+
+## [4.17.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.17.1) (2021-06-18)
+- **WARNING**: Remove total_count field from meta data for list MDR response
+
+## [4.17.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.17.0) (2021-06-15)
+- Added stir verification param as part of Get CDR and live call APIs response.
+
 ## [4.16.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.16.0) (2021-02-08)
 - Add support for Regulatory Compliance APIs.
 

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:3.0.1-alpine
+
+RUN apk update && apk add git vim bash make gcc musl-dev
+
+WORKDIR /usr/src/app
+RUN gem install json --source 'https://rubygems.org/'
+
+# Copy setup script
+COPY setup_sdk.sh /usr/src/app/
+RUN chmod a+x /usr/src/app/setup_sdk.sh
+
+ENTRYPOINT [ "/usr/src/app/setup_sdk.sh" ]

data/Gemfile

@@ -7,4 +7,5 @@ group :test do
   gem 'rspec', '~> 3.0'
   gem 'simplecov'
   gem 'json'
+  gem 'rexml'
 end

data/Makefile

@@ -0,0 +1,18 @@
+.PHONY: build test
+
+build:
+	docker-compose up --build --remove-orphans
+
+start:
+	docker-compose up --build --remove-orphans --detach
+	docker attach $(shell docker-compose ps -q rubySDK)
+
+test:
+	@[ "${CONTAINER}" ] && \
+		docker exec -it $$CONTAINER /bin/bash -c "bundle exec rake" || \
+		bundle exec rake
+
+run:
+	@[ "${CONTAINER}" ] && \
+		(docker exec -it $$CONTAINER /bin/bash -c 'cd /usr/src/app/ruby-sdk-test/ && ruby test.rb') || \
+		(cd /usr/src/app/ruby-sdk-test/ && ruby test.rb)