-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added FormsApi and the related classes, created WIP moments.md exampl…
…e file, updated CHANGELOG.md
- Loading branch information
1 parent
a04615b
commit 70a5637
Showing
15 changed files
with
2,868 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
# Moments quickstart | ||
|
||
This quick guide aims to help you start with [Infobip Moments](https://api-docs.ioinfobip.com/docs/api/customer-engagement/moments). After reading it, you should know how to use Moments. | ||
|
||
The first step is to create an `ApiClient` instance with some configuration. | ||
|
||
```java | ||
ApiClient apiClient = ApiClient.forApiKey(ApiKey.from(API_KEY)) | ||
.withBaseUrl(BaseUrl.from(BASE_URL)) | ||
.build(); | ||
``` | ||
|
||
## Flow API | ||
|
||
You can now create an instance of `FlowApi` which allows you to manage your flows. | ||
|
||
````java | ||
FlowApi flowApi = new FlowApi(apiClient); | ||
```` | ||
### Add participants to flow | ||
|
||
To add participants to a flow, you can use the following code: | ||
|
||
````java | ||
// TODO add code example here | ||
```` | ||
|
||
### Get a report on participants added to flow | ||
|
||
To fetch a report to confirm that all persons have been successfully added to the flow, you can use the following code: | ||
|
||
````java | ||
// TODO add code example here | ||
```` | ||
|
||
### Remove person from flow | ||
|
||
To remove a person from a flow, you can use the following code: | ||
|
||
````java | ||
// TODO add code example here | ||
```` | ||
|
||
|
||
## Forms API | ||
|
||
You can now create an instance of `FormsApi` which allows you to manage your forms. | ||
|
||
````java | ||
FormsApi formsApi = new FlowApi(apiClient); | ||
```` | ||
|
||
### Get forms | ||
|
||
To get all forms, you can use the following code: | ||
|
||
````java | ||
// TODO add code example here | ||
```` | ||
|
||
### Get form by ID | ||
|
||
To get a specific form by ID, you can use the following code: | ||
|
||
````java | ||
// TODO add code example here | ||
```` | ||
|
||
### Increment form view count | ||
|
||
To increase the view counter of a specific form, you can use the following code: | ||
|
||
````java | ||
String formId = "cec5dfd2-4238-48e0-933b-9acbdb2e6f5f"; | ||
FormsStatusResponse response = formsApi | ||
.incrementViewCount(formId) | ||
.execute(); | ||
```` | ||
|
||
### Submit form data | ||
|
||
To submit data to a specific form, you can use the following code: | ||
|
||
````java | ||
// TODO add code example here | ||
```` |
Oops, something went wrong.