https://github.com/imryan/approveapi
✅ ApproveAPI in Swift.
https://github.com/imryan/approveapi
approveapi rest-api
Last synced: 2 months ago
JSON representation
✅ ApproveAPI in Swift.
- Host: GitHub
- URL: https://github.com/imryan/approveapi
- Owner: imryan
- License: mit
- Created: 2019-03-01T02:34:45.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-05T16:51:15.000Z (over 6 years ago)
- Last Synced: 2025-02-21T05:05:06.011Z (10 months ago)
- Topics: approveapi, rest-api
- Language: Swift
- Homepage: https://approveapi.com
- Size: 314 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ✅ ApproveAPI
[](https://travis-ci.org/imryan/ApproveAPI)
[](https://cocoapods.org/pods/ApproveAPI)
[](https://cocoapods.org/pods/ApproveAPI)
[](https://cocoapods.org/pods/ApproveAPI)
## Example
To run the example project, clone the repo, and run `pod install` from the Example directory first.
## Requirements
- Alamofire
## Installation
ApproveAPI is available through [CocoaPods](https://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'ApproveAPI'
```
## Usage
#### Create ApproveAPI client with API key
```swift
let approveClient = ApproveAPI(apiKey: "your-api-key", isTestKey: true, delegate: nil)
```
#### Send a Prompt
```swift
// Create metadata
let metadata = AnswerMetadataPost(location: "New York, NY", timestamp: "9:41 AM")
metadata.browser = UIDevice.current.model
// Create Prompt request object
var request = PromptRequest(userType: .email("someone@email.com"), body: "Demo body message.")
request.title = "Optional prompt title"
request.metadata = metadata
// Send prompt to provided user address
approveClient.sendPrompt(withRequest: request) { (prompt, error) in
guard let promptId = prompt?.id, error == nil else {
debugPrint("Error:", error ?? "N/A")
return
}
debugPrint("Prompt Send:", prompt ?? "None")
}
```
#### Retrieve a Prompt
```swift
approveClient.retreivePrompt(withId: "prompt_id") { (prompt, error) in
guard let promptId = prompt?.id, error == nil else {
debugPrint("Error:", error ?? "N/A")
return
}
debugPrint("Prompt Retrieval:", prompt ?? "None")
}
```
#### Get Prompt status
```swift
approveClient.checkPromptStatus(withId: "prompt_id") { (status, error) in
guard let status = status, error == nil else {
debugPrint("Error:", error ?? "N/A")
return
}
debugPrint("Prompt Status:", status)
}
```
#### Send prompt (with delegate response)
```swift
// Create Prompt request object
var request = PromptRequest(userType: .email("someone@email.com"), body: "Demo body message.")
request.longPoll = true // Wait for user response
// Will notify via delegate
approveClient.delegate = self // Can also set on init()
approveClient.sendPrompt(withRequest: request, completion: nil)
```
```swift
extension ViewController: ApproveAPIProtocol {
func approveClient(_ client: ApproveAPI, promptChanged prompt: Prompt) {
debugPrint("Prompt changed:", prompt)
}
func approveClient(_ client: ApproveAPI, promptStatusChanged status: PromptStatus) {
debugPrint("Status changed:", status)
}
}
```
## Author
Ryan Cohen, notryancohen@gmail.com
## License
ApproveAPI is available under the MIT license. See the LICENSE file for more info.