feat(ad-hoc): update documentation (#358)

* Update documentation * Add missing UI deprecations in ProcessOut and UI modules
processout · Oct 2, 2024 · 744f05d · 744f05d
1 parent a721ff6
commit 744f05d
Show file tree

Hide file tree

Showing 47 changed files with 105 additions and 83 deletions.
diff --git a/Sources/ProcessOut/ProcessOut.docc/3DS.md b/Sources/ProcessOut/ProcessOut.docc/3DS.md
@@ -19,10 +19,17 @@ package.
 
 ### 3DS Redirect
 
-Method ``PO3DSService/handle(redirect:completion:)`` is a part of 3DS service that is responsible for handling web
-based redirects. 
-
-We provide an extension of `SFSafariViewController` (defined in `ProcessOutUI` package) that can be used to create an
-instance, capable of handling redirects. 
-
-For additional details on 3DS UI see dedicated [documentation.](https://swiftpackageindex.com/processout/processout-ios/documentation/processoutui/3ds)
+In order to handle redirects your application should support deep links. When application receives incoming URL you
+should notify ProcessOut SDK so it has a chance to handle it. 
+
+For example if you are using scene delegate it may look like following:
+
+```swift
+func scene(_ scene: UIScene, openURLContexts urlContexts: Set<UIOpenURLContext>) {
+    guard let url = urlContexts.first?.url else {
+    return
+}
+let isHandled = ProcessOut.shared.processDeepLink(url: url)
+print(isHandled)
+}
+```
diff --git a/Sources/ProcessOut/ProcessOut.docc/ProcessOut.md b/Sources/ProcessOut/ProcessOut.docc/ProcessOut.md
@@ -17,6 +17,8 @@ ProcessOut.configure(configuration: configuration)
 
 - ``ProcessOut/ProcessOut``
 - ``ProcessOutConfiguration``
+- ``ProcessOutApi``
+- ``ProcessOutApiConfiguration``
 - <doc:Localizations>
 - <doc:MigrationGuides>
 
@@ -29,9 +31,14 @@ All errors that could happen as a result of interaction with the SDK are represe
 ### 3DS
 
 - <doc:3DS>
-- ``PO3DSService``
+- ``PO3DS2Service``
 - ``PO3DS2Configuration``
 - ``PO3DS2ConfigurationCardScheme``
+- ``PO3DS2AuthenticationRequestParameters``
+- ``PO3DS2ChallengeParameters``
+- ``PO3DS2ChallengeResult``
+- ``PO3DSServiceType``
+- ``PO3DSService``
 - ``PO3DS2AuthenticationRequest``
 - ``PO3DS2Challenge``
 - ``PO3DSRedirect``
@@ -49,12 +56,17 @@ All errors that could happen as a result of interaction with the SDK are represe
 - ``PONativeAlternativePaymentMethodEvent``
 - ``PONativeAlternativePaymentMethodDelegate``
 
-### Alternative Payment Method
+### Alternative Payments
 
-- ``POAlternativePaymentMethodViewControllerBuilder``
+- ``POAlternativePaymentsService``
+- ``POAlternativePaymentAuthorizationRequest``
+- ``POAlternativePaymentTokenizationRequest``
+- ``POAlternativePaymentResponse``
 - ``POAlternativePaymentMethodsService``
+- ``POAlternativePaymentMethodsServiceType``
 - ``POAlternativePaymentMethodRequest``
 - ``POAlternativePaymentMethodResponse``
+- ``POAlternativePaymentMethodViewControllerBuilder``
 
 ### Cards
 
@@ -70,12 +82,14 @@ All errors that could happen as a result of interaction with the SDK are represe
 - ``POCardIssuerInformation``
 - ``POCardCvcCheck``
 - ``POCardScheme``
+- ``POCardsServiceType``
 
 ### Customer Tokens
 
 - ``POCustomerTokensService``
 - ``POAssignCustomerTokenRequest``
 - ``POCustomerToken``
+- ``POCustomerTokensServiceType``
 
 ### Gateway Configurations
 
@@ -84,6 +98,7 @@ All errors that could happen as a result of interaction with the SDK are represe
 - ``POAllGatewayConfigurationsRequest``
 - ``POFindGatewayConfigurationRequest``
 - ``POGatewayConfiguration``
+- ``POGatewayConfigurationsRepositoryType``
 
 ### Invoices
 
@@ -99,6 +114,7 @@ All errors that could happen as a result of interaction with the SDK are represe
 - ``PONativeAlternativePaymentMethodTransactionDetailsRequest``
 - ``PONativeAlternativePaymentMethodParameterValues``
 - ``PONativeAlternativePaymentMethodState``
+- ``POInvoicesServiceType``
 <!--- ``PODynamicCheckoutPaymentMethod``-->
 
 ### Appearance
@@ -119,6 +135,8 @@ Types that describe properties such as shadow and border. And style of higher le
 - ``POActivityIndicatorStyle``
 - ``POActivityIndicatorView``
 - ``POActionsContainerStyle``
+- ``POTextFieldStyle``
+- ``POActivityIndicatorViewType``
 
 ### Images Utils
 
@@ -140,6 +158,9 @@ Types that describe properties such as shadow and border. And style of higher le
 - ``POBillingAddressCollectionMode``
 - ``PORepository``
 - ``POService``
+- ``POCancellableType``
+- ``PORepositoryType``
+- ``POServiceType``
 - ``POAutoAsync``
 - ``POAutoCompletion``
 

diff --git a/Sources/ProcessOut/Sources/Api/Models/ProcessOutConfiguration.swift b/Sources/ProcessOut/Sources/Api/Models/ProcessOutConfiguration.swift
@@ -11,7 +11,7 @@ import Foundation
 public typealias ProcessOutApiConfiguration = ProcessOutConfiguration
 
 /// Defines configuration parameters that are used to create API singleton. In order to create instance
-/// of this structure one should use ``ProcessOutConfiguration/production(projectId:appVersion:isDebug:)``
+/// of this structure one should use ``ProcessOutConfiguration/init(projectId:application:isDebug:isTelemetryEnabled:)``
 /// method.
 public struct ProcessOutConfiguration {
 

diff --git a/Sources/ProcessOut/Sources/Legacy/ProcessOutLegacyApi.swift b/Sources/ProcessOut/Sources/Legacy/ProcessOutLegacyApi.swift
@@ -364,7 +364,7 @@ public final class ProcessOutLegacyApi {
     /// Initiate a payment authorization from a previously generated invoice and card token
     ///
     /// - Parameters:
-    ///   - AuthorizationRequest: contains all the necessary fields to initiate an authorisation request.
+    ///   - request: contains all the necessary fields to initiate an authorisation request.
     ///   - handler: Custom 3DS2 handler (please refer to our documentation for this)
     ///   - with: UIViewController to display webviews and perform fingerprinting
     public static func makeCardPayment(AuthorizationRequest request: AuthorizationRequest, handler: ThreeDSHandler, with: UIViewController) {
@@ -443,7 +443,7 @@ public final class ProcessOutLegacyApi {
     /// Initiate an incremental payment authorization from a previously generated invoice and card token
     ///
     /// - Parameters:
-    ///   - AuthorizationRequest: contains all the necessary fields to initiate an authorisation request.
+    ///   - request: contains all the necessary fields to initiate an authorisation request.
     ///   - handler: Custom 3DS2 handler (please refer to our documentation for this)
     ///   - with: UIViewController to display webviews and perform fingerprinting
     public static func makeIncrementalAuthorizationPayment(AuthorizationRequest request: AuthorizationRequest, handler: ThreeDSHandler, with: UIViewController) {
@@ -502,7 +502,6 @@ public final class ProcessOutLegacyApi {
     /// Create a customer token from a card ID
     ///
     /// - Parameters:
-    ///   - cardId: Card ID used for the customer token
     ///   - customerId: Customer ID created in backend
     ///   - tokenId: Token ID created in backend
     ///   - handler: 3DS2 handler
@@ -560,7 +559,6 @@ public final class ProcessOutLegacyApi {
     /// Create a customer token from a card ID
     ///
     /// - Parameters:
-    ///   - cardId: Card ID used for the customer token
     ///   - customerId: Customer ID created in backend
     ///   - tokenId: Token ID created in backend
     ///   - thirdPartySDKVersion: Version of the 3rd party SDK being used for the calls. Can be blank if unused
@@ -620,7 +618,7 @@ public final class ProcessOutLegacyApi {
     /// Create a customer token from a card ID
     ///
     /// - Parameters:
-    ///   - TokenRequest: contains all the fields necessary for the token request
+    ///   - request: contains all the fields necessary for the token request
     ///   - handler: 3DS2 handler
     ///   - with: UIViewController to display webviews and perform fingerprinting
     public static func makeCardToken(TokenRequest request: TokenRequest, handler: ThreeDSHandler, with: UIViewController) {

diff --git a/...ources/UI/Shared/DesignSystem/CollectionReusableViews/Error/CollectionViewErrorCell.swift b/...ources/UI/Shared/DesignSystem/CollectionReusableViews/Error/CollectionViewErrorCell.swift
@@ -7,6 +7,7 @@
 
 import UIKit
 
+@available(*, deprecated)
 final class CollectionViewErrorCell: UICollectionViewCell {
 
     override init(frame: CGRect) {

diff --git a/...ources/UI/Shared/DesignSystem/CollectionReusableViews/Radio/CollectionViewRadioCell.swift b/...ources/UI/Shared/DesignSystem/CollectionReusableViews/Radio/CollectionViewRadioCell.swift
@@ -7,6 +7,7 @@
 
 import UIKit
 
+@available(*, deprecated)
 final class CollectionViewRadioCell: UICollectionViewCell {
 
     override init(frame: CGRect) {

diff --git a/.../DesignSystem/CollectionReusableViews/SectionHeader/CollectionViewSectionHeaderView.swift b/.../DesignSystem/CollectionReusableViews/SectionHeader/CollectionViewSectionHeaderView.swift
@@ -7,6 +7,7 @@
 
 import UIKit
 
+@available(*, deprecated)
 final class CollectionViewSectionHeaderView: UICollectionReusableView {
 
     override init(frame: CGRect) {

diff --git a/...ources/UI/Shared/DesignSystem/CollectionReusableViews/Title/CollectionViewTitleCell.swift b/...ources/UI/Shared/DesignSystem/CollectionReusableViews/Title/CollectionViewTitleCell.swift
@@ -7,6 +7,7 @@
 
 import UIKit
 
+@available(*, deprecated)
 final class CollectionViewTitleCell: UICollectionViewCell {
 
     override init(frame: CGRect) {

diff --git a/...essOut/Sources/UI/Shared/DesignSystem/Extensions/UIActivityIndicatorView+Extensions.swift b/...essOut/Sources/UI/Shared/DesignSystem/Extensions/UIActivityIndicatorView+Extensions.swift
@@ -7,6 +7,7 @@
 
 import UIKit
 
+@available(*, deprecated)
 extension UIActivityIndicatorView: POActivityIndicatorView {
 
     public func setAnimating(_ isAnimating: Bool) {

diff --git a/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Extensions/UIView+Style.swift b/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Extensions/UIView+Style.swift
@@ -10,13 +10,15 @@ import UIKit
 extension UIView {
 
     /// Applies given border style to view's layer.
+    @available(*, deprecated)
     func apply(style: POBorderStyle) {
         layer.cornerRadius = style.radius
         layer.borderWidth = style.width
         layer.borderColor = style.color.cgColor
     }
 
     /// Applies given shadow style to view's layer.
+    @available(*, deprecated)
     func apply(style: POShadowStyle, shadowOpacity: CGFloat = 1) {
         layer.shadowColor = style.color.cgColor
         layer.shadowOpacity = Float(shadowOpacity)

diff --git a/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Styles/Input/POInputStateStyle.swift b/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Styles/Input/POInputStateStyle.swift
@@ -8,6 +8,7 @@
 import UIKit
 
 /// Defines input's styling information in a specific state.
+@available(*, deprecated, message: "Use ProcessOutUI module.")
 public struct POInputStateStyle {
 
     /// Text style.

diff --git a/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Styles/Input/POInputStyle.swift b/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Styles/Input/POInputStyle.swift
@@ -11,6 +11,7 @@ import UIKit
 public typealias POTextFieldStyle = POInputStyle
 
 /// Defines input control style in both normal and error states.
+@available(*, deprecated, message: "Use ProcessOutUI module.")
 public struct POInputStyle {
 
     /// Style for normal state.
@@ -26,6 +27,7 @@ public struct POInputStyle {
     }
 }
 
+@available(*, deprecated)
 extension POInputStyle {
 
     /// Allows to create default input style with given typography.

diff --git a/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Styles/POBorderStyle.swift b/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Styles/POBorderStyle.swift
@@ -8,6 +8,7 @@
 import UIKit
 
 /// Style that defines border appearance. Border is always a solid line.
+@available(*, deprecated, message: "Use ProcessOutUI module.")
 public struct POBorderStyle {
 
     /// Corner radius.
@@ -26,6 +27,7 @@ public struct POBorderStyle {
     }
 }
 
+@available(*, deprecated)
 extension POBorderStyle {
 
     /// Clear border of specified radius.

diff --git a/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Styles/POShadowStyle.swift b/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Styles/POShadowStyle.swift
@@ -8,6 +8,7 @@
 import UIKit
 
 /// Style that defines shadow appearance.
+@available(*, deprecated, message: "Use ProcessOutUI module.")
 public struct POShadowStyle {
 
     /// The color of the shadow.
@@ -26,6 +27,7 @@ public struct POShadowStyle {
     }
 }
 
+@available(*, deprecated)
 extension POShadowStyle {
 
     /// Value represents no shadow.

diff --git a/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Typography/AttributedStringBuilder.swift b/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Typography/AttributedStringBuilder.swift
@@ -7,6 +7,7 @@
 
 import UIKit
 
+@available(*, deprecated)
 struct AttributedStringBuilder {
 
     enum Text {
@@ -118,6 +119,7 @@ struct AttributedStringBuilder {
     }
 }
 
+@available(*, deprecated)
 extension AttributedStringBuilder {
 
     func with(updates: (inout AttributedStringBuilder) -> Void) -> AttributedStringBuilder {

diff --git a/...rocessOut/Sources/UI/Shared/DesignSystem/Typography/AttributedStringMarkdownVisitor.swift b/...rocessOut/Sources/UI/Shared/DesignSystem/Typography/AttributedStringMarkdownVisitor.swift
@@ -8,6 +8,7 @@
 import Foundation
 import UIKit
 
+@available(*, deprecated)
 final class AttributedStringMarkdownVisitor: MarkdownVisitor {
 
     init(builder: AttributedStringBuilder, level: Int = 0) {

diff --git a/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Typography/POTextStyle.swift b/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Typography/POTextStyle.swift
@@ -8,6 +8,7 @@
 import UIKit
 
 /// Text style.
+@available(*, deprecated, message: "Use ProcessOutUI module.")
 public struct POTextStyle {
 
     /// Text foreground color.

diff --git a/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Typography/POTypography.swift b/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Typography/POTypography.swift
@@ -8,6 +8,7 @@
 import UIKit
 
 /// Holds typesetting information that could be applied to displayed text.
+@available(*, deprecated, message: "Use ProcessOutUI module.")
 public struct POTypography {
 
     /// Font associated with given typography.
@@ -48,6 +49,7 @@ public struct POTypography {
     }
 }
 
+@available(*, deprecated)
 extension POTypography {
 
     enum Fixed {

diff --git a/...ocessOut/Sources/UI/Shared/DesignSystem/Views/ActionsContainer/ActionsContainerView.swift b/...ocessOut/Sources/UI/Shared/DesignSystem/Views/ActionsContainer/ActionsContainerView.swift
@@ -7,6 +7,7 @@
 
 import UIKit
 
+@available(*, deprecated)
 final class ActionsContainerView: UIView {
 
     init(style: POActionsContainerStyle, horizontalInset: CGFloat) {

diff --git a/...ssOut/Sources/UI/Shared/DesignSystem/Views/ActionsContainer/POActionsContainerStyle.swift b/...ssOut/Sources/UI/Shared/DesignSystem/Views/ActionsContainer/POActionsContainerStyle.swift
@@ -8,6 +8,7 @@
 import UIKit
 
 /// Actions container style.
+@available(*, deprecated, message: "Use ProcessOutUI module.")
 public struct POActionsContainerStyle {
 
     /// Style for primary button.

diff --git a/...Sources/UI/Shared/DesignSystem/Views/ActivityIndicator/ActivityIndicatorViewFactory.swift b/...Sources/UI/Shared/DesignSystem/Views/ActivityIndicator/ActivityIndicatorViewFactory.swift
@@ -7,6 +7,7 @@
 
 import UIKit
 
+@available(*, deprecated)
 final class ActivityIndicatorViewFactory {
 
     func create(style: POActivityIndicatorStyle) -> POActivityIndicatorView {

diff --git a/...Out/Sources/UI/Shared/DesignSystem/Views/ActivityIndicator/POActivityIndicatorStyle.swift b/...Out/Sources/UI/Shared/DesignSystem/Views/ActivityIndicator/POActivityIndicatorStyle.swift
@@ -8,6 +8,7 @@
 import UIKit
 
 /// Possible activity indicator styles.
+@available(*, deprecated, message: "Use ProcessOutUI module.")
 public enum POActivityIndicatorStyle {
 
     /// Custom activity indicator.

diff --git a/...sOut/Sources/UI/Shared/DesignSystem/Views/ActivityIndicator/POActivityIndicatorView.swift b/...sOut/Sources/UI/Shared/DesignSystem/Views/ActivityIndicator/POActivityIndicatorView.swift
@@ -12,6 +12,7 @@ public typealias POActivityIndicatorViewType = POActivityIndicatorView
 
 /// Protocol that activity indicator should conform to in order to be used with
 /// ``POActivityIndicatorStyle`` custom style.
+@available(*, deprecated, message: "Use ProcessOutUI module.")
 public protocol POActivityIndicatorView: UIView {
 
     /// Changes animation state.

diff --git a/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Views/Button/Button.swift b/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Views/Button/Button.swift
@@ -7,6 +7,7 @@
 
 import UIKit
 
+@available(*, deprecated)
 final class Button: UIControl {
 
     struct ViewModel {

diff --git a/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Views/Button/POButtonStateStyle.swift b/Sources/ProcessOut/Sources/UI/Shared/DesignSystem/Views/Button/POButtonStateStyle.swift
@@ -8,6 +8,7 @@
 import UIKit
 
 /// Defines button's styling information in a specific state.
+@available(*, deprecated, message: "Use ProcessOutUI module.")
 public struct POButtonStateStyle {
 
     /// Text typography.