station 0.0.0 → 0.0.100

data/lib/nexmo_developer/config/tutorials/en/create-and-retrieve-a-report.yml

@@ -0,0 +1,24 @@
+---
+title: Create a CSV report using the command line
+description: Create a CSV report using the command line tool, curl.
+products:
+  - reports
+
+introduction:
+  title: Introduction
+  description: Learn how to use the Reports API
+  content: |
+    # Introduction
+
+    This tutorial shows you how to create and retrieve reports using the asynchronous version of the Reports API.
+
+    To generate a report, you submit a report generation request to the ASYNC endpoint and wait for it to be processed.
+
+    The Reports API checks whether the format of the request is correct, then places it in the processing queue. It responds with a link that enables you to check the current status of the report. The Reports API can also send a callback to notify your application when the report has been generated.
+
+    > **A note on performance**: Even though the Reports API is fast and can deal with enormous amounts of data, it may becomer slower when trying to download data for realtime analytics. Using sensible filters can speed up processing considerably. Also, for frequent and periodic retrievals of small batches of data records please consider using a synchronous version of the Reports API.
+tasks:
+  - reports/create-report
+  - reports/check-report-status
+  - reports/download-report
+  - reports/reports-whats-next

data/lib/nexmo_developer/config/tutorials/en/create-report-using-graphical-tools.yml

@@ -0,0 +1,20 @@
+---
+title: Create a CSV report using a graphical tool
+description: Create a report using the graphical tool, Postman.
+products:
+  - reports
+
+introduction:
+  title: Introduction
+  description: Create a report using the graphical tool, Postman.
+  content: |
+    # Introduction
+
+    This tutorial describes how to create a report using the graphical tool [Postman](https://www.getpostman.com/). Postman’s graphical interface greatly reduces the complexity of interacting with the Reports API for non-technical users. 
+
+    > If you don't already have Postman installed, [download and install it](https://www.getpostman.com/downloads/).
+tasks:
+  - reports/create-report-postman
+  - reports/check-report-status-postman
+  - reports/download-report-postman
+  - reports/reports-whats-next

data/lib/nexmo_developer/config/tutorials/en/get-json-records-cli.yml

@@ -0,0 +1,20 @@
+---
+title: Get JSON records using the command line
+description: Get JSON records using the command line tool, `curl`.
+products:
+  - reports
+
+introduction:
+  title: Introduction
+  description: Learn how to retrieve JSON records using the command line
+  content: |
+    # Introduction
+
+    This tutorial shows you how to retrieve transactional records of your activity in JSON format using the synchronous version of the Reports API. 
+
+    Reports SYNC supports retrieval of records by the message ID, record ID or by time period. When using the time period filter, the synchronous endpoint returns results immediately in batches of up to 1000 records. The response contains a batch of data records in JSON format and a link to the next batch (if any). When using the the message/record ID filter, only one record gets returned.
+
+    > **A note on performance:** Synchronous version is optimized for frequent and periodic retrievals of small batches of data records, that is from one record to tens of thousand per query.
+tasks:
+  - reports/get-json-records
+  - reports/reports-whats-next

data/lib/nexmo_developer/config/tutorials/en/ifttt-to-sms.yml

@@ -0,0 +1,10 @@
+---
+title: Anything-to-SMS with IFTTT and Nexmo
+external_link: https://www.nexmo.com/blog/2018/09/18/anything-to-sms-ifttt-nexmo-dr/
+description: Send an SMS in response to any trigger by creating a serverless action in PHP that sends an SMS. Use IFTTT to send a webhook to the serverless action when your chosen event occurs
+products:
+ - messaging/sms
+languages:
+ - PHP
+---
+

data/lib/nexmo_developer/config/tutorials/en/in-app-messaging.yml

@@ -0,0 +1,4 @@
+title: Creating a chat app
+description: Create an application that enables users to message each other.
+products:
+  - client-sdk

data/lib/nexmo_developer/config/tutorials/en/in-app-messaging/javascript.yml

@@ -0,0 +1,50 @@
+title: Creating a web-based chat app
+description: Create a web application that enables users to message each other
+products:
+  - client-sdk
+
+introduction:
+  title: Introduction to this task
+  description: This task shows you how to create a web chat application using the JavaScript Client SDK.
+  content: |
+    # Introduction
+    In this task, you will learn how to create and configure a Client SDK Application and then code a web app that enables two users to send messages to each other.
+
+    First, you will create a Conversation and two Users. Then, you will authenticate these Users and add them to the Conversation as Members.
+
+    Finally, you will implement chat functionality in your application, including the ability to view and send messages and be notified when either party is currently typing.
+
+    The source code is available on [GitHub](https://github.com/nexmo-community/ip-messaging-tutorial).
+
+prerequisites:
+  - create-nexmo-account
+  - install-nodejs
+  - install-nexmo-cli-beta
+  - install-node-client-sdk
+  - run-ngrok
+
+tasks:
+  - client-sdk/create-application
+  - client-sdk/create-conversation
+  - client-sdk/in-app-messaging/create-users
+  - client-sdk/in-app-messaging/add-users-to-conversation
+  - client-sdk/in-app-messaging/generate-jwts
+  - client-sdk/in-app-messaging/create-ui
+  - client-sdk/in-app-messaging/authenticate-users
+  - client-sdk/in-app-messaging/join-conversation
+  - client-sdk/in-app-messaging/show-message-history
+  - client-sdk/in-app-messaging/send-message
+  - client-sdk/in-app-messaging/typing-indicators
+  - client-sdk/in-app-messaging/run-application
+
+conclusion:
+  title: What's next?
+  description: What else can you do with the Client SDK?
+  content: |
+
+    # What's next?
+    You can do a lot more with the Client SDK.
+
+    We want to hear what ideas you have in mind? Contact us at <a href="mailto:devrel@vonage.com">devrel@vonage.com</a>
+
+    See [Client SDK documentation](/client-sdk/overview).

data/lib/nexmo_developer/config/tutorials/en/in-app-messaging/kotlin.yml

@@ -0,0 +1,52 @@
+title: Creating an Android chat app
+description: Create a Android application that enables users to message each other
+products:
+  - client-sdk
+
+introduction:
+  title: Introduction to this task
+  description: This task shows you how to create a Android chat application using the Android Client SDK.
+  content: |
+    # Introduction
+    In this task, you will learn how to create and configure a Client SDK Application and then code a web app that enables two users to send messages to each other.
+
+    First, you will create a Conversation and two Users. Then, you will authenticate these Users and add them to the Conversation as Members.
+
+    Finally, you will implement chat functionality in your application, including the ability to view and send messages and be notified when a new message appears in Conversation.
+
+    The source code is available on [GitHub](https://github.com/nexmo-community/client-sdk-android-tutorial-messaging).
+
+prerequisites:
+  - create-nexmo-account
+  - install-nodejs
+  - install-nexmo-cli-beta
+  - install-android-studio
+
+tasks:
+  - client-sdk/in-app-messaging/create-application
+  - client-sdk/create-conversation
+  - client-sdk/in-app-messaging/create-users
+  - client-sdk/in-app-messaging/add-users-to-conversation
+  - client-sdk/in-app-messaging/generate-jwts
+  - client-sdk/in-app-messaging/starter-project
+  - client-sdk/in-app-messaging/initialize-client
+  - client-sdk/in-app-messaging/authenticate-users
+  - client-sdk/in-app-messaging/fetch-conversation
+  - client-sdk/in-app-messaging/fetch-events
+  - client-sdk/in-app-messaging/send-message
+  - client-sdk/in-app-messaging/receive-new-messages
+
+conclusion:
+  title: What's next?
+  description: What else can you do with the Client SDK?
+  content: |
+
+    # What's next?
+
+    For the complete version please see the Android Studio project in the `kotlin-completed` folder of the `git` repository you've cloned ([GitHub](https://github.com/nexmo-community/client-sdk-android-tutorial-messaging)).
+
+    You can do a lot more with the Client SDK. See [Client SDK documentation](/client-sdk/overview).
+
+    We want to hear what ideas you have in mind? Contact us at <a href="mailto:devrel@vonage.com">devrel@vonage.com</a>
+
+    

data/lib/nexmo_developer/config/tutorials/en/in-app-messaging/objective_c.yml

@@ -0,0 +1,50 @@
+title: Creating an iOS chat app
+description: Create a iOS application that enables users to message each other
+products:
+  - client-sdk
+
+introduction:
+  title: Introduction to this task
+  description: This task shows you how to create a iOS chat application using the iOS Client SDK.
+  content: |
+    # Introduction
+    In this task, you will learn how to create and configure a Client SDK Application and then code a web app that enables two users to send messages to each other.
+
+    First, you will create a Conversation and two Users. Then, you will authenticate these Users and add them to the Conversation as Members.
+
+    Finally, you will implement chat functionality in your application, including the ability to view and send messages and be notified when either party is currently typing.
+
+    The source code is available on [GitHub](https://github.com/Nexmo/ClientSDK-Get-Started-Messaging-Objective-C).
+
+prerequisites:
+  - create-nexmo-account
+  - install-nodejs
+  - install-nexmo-cli-beta
+  - install-xcode
+
+tasks:
+  - client-sdk/in-app-messaging/create-application
+  - client-sdk/create-conversation
+  - client-sdk/in-app-messaging/create-users
+  - client-sdk/in-app-messaging/add-users-to-conversation
+  - client-sdk/in-app-messaging/generate-jwts
+  - client-sdk/in-app-messaging/starter-project
+  - client-sdk/in-app-messaging/authenticate-users
+  - client-sdk/in-app-messaging/conversation-ui
+  - client-sdk/in-app-messaging/fetch-conversation
+  - client-sdk/in-app-messaging/fetch-events
+  - client-sdk/in-app-messaging/send-message
+  - client-sdk/in-app-messaging/receive-new-messages
+
+conclusion:
+  title: What's next?
+  description: What else can you do with the Client SDK?
+  content: |
+
+    # What's next?
+
+    For the complete version please see the Xcode workspace in the `Completed` folder of the `git` repository you've cloned.
+
+    You can do a lot more with the Client SDK. See [Client SDK documentation](/client-sdk/overview).
+
+    We want to hear what ideas you have in mind? Contact us at <a href="mailto:devrel@vonage.com">devrel@vonage.com</a>

data/lib/nexmo_developer/config/tutorials/en/in-app-messaging/swift.yml

@@ -0,0 +1,50 @@
+title: Creating an iOS chat app
+description: Create a iOS application that enables users to message each other
+products:
+  - client-sdk
+
+introduction:
+  title: Introduction to this task
+  description: This task shows you how to create a iOS chat application using the iOS Client SDK.
+  content: |
+    # Introduction
+    In this task, you will learn how to create and configure a Client SDK Application and then code a web app that enables two users to send messages to each other.
+
+    First, you will create a Conversation and two Users. Then, you will authenticate these Users and add them to the Conversation as Members.
+
+    Finally, you will implement chat functionality in your application, including the ability to view and send messages and be notified when either party is currently typing.
+
+    The source code is available on [GitHub](https://github.com/Nexmo/ClientSDK-Get-Started-Messaging-Swift).
+
+prerequisites:
+  - create-nexmo-account
+  - install-nodejs
+  - install-nexmo-cli-beta
+  - install-xcode
+
+tasks:
+  - client-sdk/in-app-messaging/create-application
+  - client-sdk/create-conversation
+  - client-sdk/in-app-messaging/create-users
+  - client-sdk/in-app-messaging/add-users-to-conversation
+  - client-sdk/in-app-messaging/generate-jwts
+  - client-sdk/in-app-messaging/starter-project
+  - client-sdk/in-app-messaging/authenticate-users
+  - client-sdk/in-app-messaging/conversation-ui
+  - client-sdk/in-app-messaging/fetch-conversation
+  - client-sdk/in-app-messaging/fetch-events
+  - client-sdk/in-app-messaging/send-message
+  - client-sdk/in-app-messaging/receive-new-messages
+
+conclusion:
+  title: What's next?
+  description: What else can you do with the Client SDK?
+  content: |
+
+    # What's next?
+
+    For the complete version please see the Xcode workspace in the `Completed` folder of the `git` repository you've cloned.
+
+    You can do a lot more with the Client SDK. See [Client SDK documentation](/client-sdk/overview).
+
+    We want to hear what ideas you have in mind? Contact us at <a href="mailto:devrel@vonage.com">devrel@vonage.com</a>

data/lib/nexmo_developer/config/tutorials/en/number-insight-api-aspnet.yml

@@ -0,0 +1,11 @@
+---
+title: Getting Started with Nexmo Number Insight APIs and ASP.NET
+external_link: https://www.nexmo.com/blog/2018/05/22/getting-started-with-nexmo-number-insight-apis-and-asp-net-dr/
+image_url: https://www.nexmo.com/wp-content/uploads/2018/05/Number-Insight-Nexmo-01-600x300.png
+description: Detailed tutorial on how you can get real-time intelligence about a phone number using ASP.NET and Nexmo Number Insight APIs.
+products:
+  - number-insight
+languages:
+ - dotnet
+---
+

data/lib/nexmo_developer/config/tutorials/en/phone-to-app.yml

@@ -0,0 +1,4 @@
+title: Receiving an in-app voice call
+description: Your web app receives an inbound phone call.
+products:
+  - client-sdk

data/lib/nexmo_developer/config/tutorials/en/phone-to-app/javascript.yml

@@ -0,0 +1,38 @@
+introduction:
+  title: Introduction to this task
+  description: This task shows you how to handle an inbound call into your web app using the JavaScript Client SDK.
+  content: |
+    # Introduction
+    In this tutorial, you will learn how to create a Client SDK application and then write the code to receive an
+    inbound <abbr title="Public Switched Telephone Network">PSTN</abbr> call.
+    To achieve this, you will need:
+    * A web application that will notify the service agent of an inbound call and offer the ability to answer it
+    * A webhook server that can process an inbound webhook and return an <abbr title="Nexmo Call Control Object">NCCO</abbr> to forward the inbound call to your application
+prerequisites:
+- create-nexmo-account
+- install-nodejs
+- install-node-client-sdk
+- install-nexmo-cli-beta
+- install-express
+- run-ngrok
+
+tasks:
+- client-sdk/create-application
+- buy-nexmo-number
+- link-nexmo-number
+- client-sdk/create-user
+- client-sdk/generate-jwt
+- client-sdk/phone-to-app/create-webhook-server
+- client-sdk/phone-to-app/code
+- client-sdk/phone-to-app/run
+
+conclusion:
+  title: What's next?
+  description: What else can you do with the Client SDK?
+  content: |
+    # What's next?
+    You can do a lot more with the Client SDK.
+
+    We want to hear what ideas you have in mind? Contact us at [devrel@vonage.com](mailto:devrel@vonage.com)
+
+    See [Client SDK documentation](/client-sdk/overview).

data/lib/nexmo_developer/config/tutorials/en/receive-sms-dotnet.yml

@@ -0,0 +1,9 @@
+---
+title: Receive SMS Messages with ASP.NET MVC Framework
+external_link: https://www.nexmo.com/blog/2017/03/31/recieve-sms-messages-with-asp-net-mvc-framework-dr/
+products:
+ - messaging/sms
+description: A tutorial to show how your ASP .NET MVC application can use the Nexmo c# library to receive SMS messages from your users and display them in your output window.
+languages:
+ - dotnet
+---

data/lib/nexmo_developer/config/tutorials/en/receive-sms-with-java.yml

@@ -0,0 +1,9 @@
+---
+title: Receive SMS Messages with Java
+external_link: https://www.nexmo.com/blog/2017/05/31/receive-sms-messages-java-dr/
+products:
+ - messaging/sms
+description: This tutorial walks you through creating a servlet to receive incoming SMS messages from your users. You'll learn how to configure your Nexmo number and account, set up the servlet, and have the incoming messages logged to the console.
+languages:
+  - Java
+---

data/lib/nexmo_developer/config/tutorials/en/receive-sms-with-php.yml

@@ -0,0 +1,10 @@
+---
+title: Receiving an SMS with PHP
+external_link: https://www.nexmo.com/blog/2018/06/19/receiving-an-sms-with-php-dr/
+products:
+  - messaging/sms
+description: Walk through of how to receive an SMS in your PHP project
+languages:
+  - PHP
+---
+

data/lib/nexmo_developer/config/tutorials/en/receive-sms-with-ruby.yml

@@ -0,0 +1,9 @@
+---
+title: How to Receive SMS Messages with Ruby on Rails
+external_link: https://www.nexmo.com/blog/2017/10/23/receive-sms-messages-ruby-on-rails-dr/
+products:
+ - messaging/sms
+description: Handle incoming SMS from users in your Ruby on Rails application.
+languages:
+  - Ruby
+---

data/lib/nexmo_developer/config/tutorials/en/send-facebook-message-with-failover.yml

@@ -0,0 +1,41 @@
+title: Sending a Facebook message with failover
+description: The Dispatch API provides the ability to create message workflows with failover to secondary channels. This task looks at using the Dispatch API to send a Facebook message with failover to the SMS channel.
+products:
+  - dispatch
+
+introduction: 
+  title: Introduction to this task
+  description: This task shows you how to use the failover functionality of the Dispatch API.
+  content: |
+    # Introduction
+    The [Dispatch API](/dispatch/overview) features workflows with automatic failover. In this tutorial you see how to send a Facebook Messenger message with automatic failover to SMS.
+
+    This tutorial provides a step-by-step guide to installing the required tools, building your application, writing the code and testing. The message sent is plain text.
+
+    For further background information on Facebook messaging see our [supporting documentation](/messages/concepts/facebook).
+
+    > **NOTE:** This task assumes you have already created a Facebook Profile and a Facebook Page.
+
+prerequisites:
+- create-nexmo-account
+- install-nodejs
+- install-nexmo-cli-beta
+- install-node-sdk-beta
+- messages-dispatch/create-application
+- messages-dispatch/configure-webhooks
+- messages-dispatch/write-webhook-server
+- messages-dispatch/test-webhook-server
+
+tasks:
+- messages-dispatch/link-facebook-page
+- messages-dispatch/send-facebook-failover
+
+conclusion:
+  title: What's next?
+  description: What else can you do with the Dispatch API?
+  content: |
+
+    # What's next?
+    You can do a lot more with the Dispatch API.
+
+    See [Dispatch API documentation](/dispatch/overview) and [a multi-user, multi-channel workflow Dispatch use case](/use-cases/dispatch-user-fallback).

data/lib/nexmo_developer/config/tutorials/en/send-fbm-message.yml

@@ -0,0 +1,42 @@
+title: Sending a Facebook Messenger message
+description: The Messages API provides the ability to send messages to various channels, including Facebook Messenger, SMS, WhatsApp and Viber. This task looks at using the Messages API to send a Facebook Messenger message.
+products:
+  - messages
+
+introduction: 
+  title: Introduction to this tutorial
+  description: This tutorial shows you how to send a Facebook Messenger message with Messages API.
+  content: |
+    # Introduction
+    The [Messages API](/messages/overview) allows you to send a Facebook Messenger message. In this tutorial you learn how to receive a Messenger message and then return a message.
+
+    This tutorial provides a step-by-step guide to installing the required tools, building your application, writing the code and testing. The message sent is plain text.
+
+    For further background information on WhatsApp messaging see our [supporting documentation](/messages/concepts/facebook).
+
+    > **NOTE:** This task assumes you have already created a Facebook Profile and a Facebook Page.
+
+prerequisites:
+- create-nexmo-account
+- install-nodejs
+- install-nexmo-cli-beta
+- install-node-sdk-beta
+- messages-dispatch/create-application
+- messages-dispatch/configure-webhooks
+- messages-dispatch/write-webhook-server
+- messages-dispatch/test-webhook-server
+
+tasks:
+- messages-dispatch/link-facebook-page
+- messages-dispatch/receive-facebook-message
+- messages-dispatch/send-facebook-message
+
+conclusion:
+  title: What's next?
+  description: What else can you do with the Messages API?
+  content: |
+
+    # What's next?
+    You can do a lot more with the Messages API.
+
+    See [Messages API documentation](/messages/overview).