Skip to content

Commit

Permalink
Release v4.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
runner authored and runner committed Oct 30, 2023
1 parent 5adc1ce commit 4f33380
Show file tree
Hide file tree
Showing 212 changed files with 49,558 additions and 0 deletions.
1 change: 1 addition & 0 deletions Cartfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github "stripe/stripe-ios" == 23.17.2
10 changes: 10 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
**Olo Pay Software Development Kit License Agreement**

Copyright © 2022 Olo Inc. All rights reserved.

Subject to the terms and conditions of the license, you are hereby granted a non-exclusive, worldwide, royalty-free license to (a) copy and modify the software in source code or binary form for your use in connection with the software services and interfaces provided by Olo, and (b) redistribute unmodified copies of the software to third parties. The above copyright notice and this license shall be included in or with all copies or substantial portions of the software.

Your use of this software is subject to the Olo APIs Terms of Use, available at https://www.olo.com/api-usage-terms. This license does not grant you permission to use the trade names, trademarks, service marks, or product names of Olo, except as required for reasonable and customary use in describing the origin of the software and reproducing the content of this license.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

22 changes: 22 additions & 0 deletions OloPaySDK.podspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Pod::Spec.new do |spec|
spec.name = "OloPaySDK"
spec.version = "4.0.0"
spec.summary = "A CocoaPods library for the Olo Pay SDK written in Swift"
spec.description = <<-DESC
Olo Pay is an E-commerce payment solution designed to help restaurants grow, protect, and support their digital ordering and delivery business. Olo Pay is specifically designed for digital restaurant ordering to address the challenges and concerns that weʼve heard from thousands of merchants.
DESC

spec.homepage = "https://github.com/ololabs/olo-pay-ios-sdk-releases"
spec.license = { :type => "Olo Pay SDK License", :file => "LICENSE.md" }
spec.author = "Olo, Inc."

spec.platform = :ios
spec.ios.deployment_target = "13.0"
spec.swift_version = "5.0"

spec.source = { :git => "https://github.com/ololabs/olo-pay-ios-sdk-releases.git", :tag => "v#{spec.version}" }
spec.source_files = "**/src/OloPaySDK/OloPaySDK/**/*.{h,m,swift}"
spec.public_header_files = "**/src/OloPaySDK/OloPaySDK/**/*.h"
spec.dependency "Stripe", "23.17.2"
spec.resource_bundles = {"OloPaySDK" => [ "**/src/OloPaySDK/OloPaySDK/Assets/**/SdkInfo.plist" ]}
end
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Olo Pay iOS SDK

## About Olo Pay
[Olo Pay](https://www.olo.com/solutions/pay/) is an E-commerce payment solution designed to help restaurants grow, protect, and support their digital ordering and delivery business. Olo Pay is specifically designed for digital restaurant ordering to address the challenges and concerns that weʼve heard from thousands of merchants.

## About the SDK
The Olo Pay iOS SDK allows partners to easily add PCI-compliant credit card and Google Pay functionality to their checkout flow and seamlessly integrate with the Olo Ordering API.

This repo contains source code and documentation for the Olo Pay iOS SDK. Use of the SDK is subject to the terms of the [Olo Pay SDK License](https://github.com/ololabs/olo-pay-ios-sdk-releases/blob/main/LICENSE.md).

For more information about integrating Olo Pay into your payment solutions, refer to our [Olo Pay Dev Portal Documentation](https://developer.olo.com/docs/load/olopay) _(Note: requires an Olo Developer account)_.

## Integrate the SDK

The Olo Pay SDK supports Carthage and CocoaPods dependency management systems.

Documentation for the Olo Pay SDK, including setup instructions and full class documentation, can be downloaded for each [SDK release](https://github.com/ololabs/olo-pay-ios-sdk-releases/releases). After downloading, open `documentation/index.html` and follow the steps outlined in the [Setup] section.
2 changes: 2 additions & 0 deletions carthage-update.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/bin/bash
carthage update --use-xcframeworks --no-use-binaries --platform iOS
553 changes: 553 additions & 0 deletions documentation/Classes.html

Large diffs are not rendered by default.

509 changes: 509 additions & 0 deletions documentation/Classes/OPApplePayContext.html

Large diffs are not rendered by default.

477 changes: 477 additions & 0 deletions documentation/Classes/OPError.html

Large diffs are not rendered by default.

1,083 changes: 1,083 additions & 0 deletions documentation/Classes/OPPaymentCardCvvView.html

Large diffs are not rendered by default.

397 changes: 397 additions & 0 deletions documentation/Classes/OPPaymentCardDetailsForm.html

Large diffs are not rendered by default.

1,734 changes: 1,734 additions & 0 deletions documentation/Classes/OPPaymentCardDetailsView.html

Large diffs are not rendered by default.

412 changes: 412 additions & 0 deletions documentation/Classes/OPSetupParameters.html

Large diffs are not rendered by default.

572 changes: 572 additions & 0 deletions documentation/Classes/OPStrings.html

Large diffs are not rendered by default.

452 changes: 452 additions & 0 deletions documentation/Classes/OloPayAPI.html

Large diffs are not rendered by default.

269 changes: 269 additions & 0 deletions documentation/Classes/OloPayApiInitializer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,269 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>OloPayApiInitializer Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>

</head>
<body>
<a name="//apple_ref/swift/Class/OloPayApiInitializer" class="dashAnchor"></a>
<a title="OloPayApiInitializer Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Olo Pay SDK</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">OloPaySDK Reference</a>
<img id="carat" src="../img/carat.png" alt=""/>
OloPayApiInitializer Class Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Guides.html">Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../changelog.html">Changelog</a>
</li>
<li class="nav-group-task">
<a href="../setup---carthage.html">Setup - Carthage</a>
</li>
<li class="nav-group-task">
<a href="../setup---cocoapods.html">Setup - CocoaPods</a>
</li>
<li class="nav-group-task">
<a href="../setup---manual.html">Setup - Manual</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes/OPApplePayContext.html">OPApplePayContext</a>
</li>
<li class="nav-group-task">
<a href="../Classes/OPError.html">OPError</a>
</li>
<li class="nav-group-task">
<a href="../Classes/OPPaymentCardCvvView.html">OPPaymentCardCvvView</a>
</li>
<li class="nav-group-task">
<a href="../Classes/OPPaymentCardDetailsForm.html">OPPaymentCardDetailsForm</a>
</li>
<li class="nav-group-task">
<a href="../Classes/OPPaymentCardDetailsView.html">OPPaymentCardDetailsView</a>
</li>
<li class="nav-group-task">
<a href="../Classes/OPSetupParameters.html">OPSetupParameters</a>
</li>
<li class="nav-group-task">
<a href="../Classes/OPStrings.html">OPStrings</a>
</li>
<li class="nav-group-task">
<a href="../Classes/OloPayAPI.html">OloPayAPI</a>
</li>
<li class="nav-group-task">
<a href="../Classes/OloPayApiInitializer.html">OloPayApiInitializer</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/OPApplePayContextError.html">OPApplePayContextError</a>
</li>
<li class="nav-group-task">
<a href="../Enums/OPCardBrand.html">OPCardBrand</a>
</li>
<li class="nav-group-task">
<a href="../Enums/OPCardErrorType.html">OPCardErrorType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/OPCardField.html">OPCardField</a>
</li>
<li class="nav-group-task">
<a href="../Enums/OPCardFormStyle.html">OPCardFormStyle</a>
</li>
<li class="nav-group-task">
<a href="../Enums/OPEnvironment.html">OPEnvironment</a>
</li>
<li class="nav-group-task">
<a href="../Enums/OPErrorType.html">OPErrorType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/OPPaymentStatus.html">OPPaymentStatus</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/OPApplePayContextDelegate.html">OPApplePayContextDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/OPApplePayContextProtocol.html">OPApplePayContextProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/OPCardFieldStateProtocol.html">OPCardFieldStateProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/c:@M@OloPaySDK@objc(pl)OPCvvTokenParamsProtocol">OPCvvTokenParamsProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/OPCvvUpdateTokenProtocol.html">OPCvvUpdateTokenProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/OPPaymentCardCvvViewDelegate.html">OPPaymentCardCvvViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/OPPaymentCardDetailsFormDelegate.html">OPPaymentCardDetailsFormDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/OPPaymentCardDetailsViewDelegate.html">OPPaymentCardDetailsViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/c:@M@OloPaySDK@objc(pl)OPPaymentMethodParamsProtocol">OPPaymentMethodParamsProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/OPPaymentMethodProtocol.html">OPPaymentMethodProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/OloPayAPIProtocol.html">OloPayAPIProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/OloPayApiInitializerProtocol.html">OloPayApiInitializerProtocol</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Typealiases.html#/s:9OloPaySDK07OPAppleB15CompletionBlocka">OPApplePayCompletionBlock</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:9OloPaySDK21OPCardBrandImageBlocka">OPCardBrandImageBlock</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:9OloPaySDK23OPCardErrorMessageBlocka">OPCardErrorMessageBlock</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:9OloPaySDK22OPCvvErrorMessageBlocka">OPCvvErrorMessageBlock</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:9OloPaySDK31OPCvvTokenUpdateCompletionBlocka">OPCvvTokenUpdateCompletionBlock</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:9OloPaySDK30OPPaymentMethodCompletionBlocka">OPPaymentMethodCompletionBlock</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:9OloPaySDK11OPVoidBlocka">OPVoidBlock</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>OloPayApiInitializer</h1>
<div class="declaration">
<div class="language">

<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">OloPayApiInitializer</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="../Protocols/OloPayApiInitializerProtocol.html">OloPayApiInitializerProtocol</a></span></code></pre>

</div>
</div>
<p>Class to set up and initialize the Olo Pay API</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:@M@OloPaySDK@objc(cs)OloPayApiInitializer(im)setupWith:completion:"></a>
<a name="//apple_ref/swift/Method/setup(with:completion:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@OloPaySDK@objc(cs)OloPayApiInitializer(im)setupWith:completion:">setup(with:<wbr>completion:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Setup the Olo Pay API</p>
<div class="aside aside-important">
<p class="aside-title">Important</p>
<p>This should be called as early as possible in the app, preferably in the AppDelegate or SceneDelegate.</p>

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">setup</span><span class="p">(</span><span class="n">with</span> <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Classes/OPSetupParameters.html">OPSetupParameters</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9OloPaySDK11OPVoidBlocka">OPVoidBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>parameters</em>
</code>
</td>
<td>
<div>
<p>Optional parameters to customize the Olo Pay API</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>Optional completion handler for when the SDK is fully initialized</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://github.com/ololabs/olo-pay-ios-sdk-releases" target="_blank" rel="external noopener">Olo, Inc.</a>. All rights reserved. (Last updated: 2023-10-30)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</html>

0 comments on commit 4f33380

Please sign in to comment.