MNFTransactionSeries

Objective-C

@interface MNFTransactionSeries : MNFObject

Swift

class MNFTransactionSeries : MNFObject

The MNFTransactionSeries class encapsulates transaction series json data in an object.

A transaction series should not be directly initialized but fetched from the server. Transaction series represents transaction aggregation.

Immutable properties

  • @abstract The time resolution of the series. (None/Day/Week/Month/Year).

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull timeResolution;

    Swift

    var timeResolution: String { get }

  • @abstract Statistics for the series over time. Only returned if overTime on the series filter is set to true.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) MNFTransactionSeriesStatistics *_Nonnull statistics;

    Swift

    @NSCopying var statistics: MNFTransactionSeriesStatistics { get }

  • @abstract The values for the transaction series.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<MNFTransactionSeriesValue *> *_Nonnull values;

    Swift

    var values: [MNFTransactionSeriesValue] { get }

  • @abstract The transactions used to create the series. Only returned if includeTransactions on the series filter is set to true.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<MNFTransaction *> *_Nonnull transactions;

    Swift

    var transactions: [MNFTransaction] { get }

  • @abstract The ids of the transactions used to create the series. Only returned if includeTransactionIds on the series filter is set to true.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<NSNumber *> *_Nonnull transactionIds;

    Swift

    var transactionIds: [NSNumber] { get }

Fetching

  • @abstract Fetches a transaction series from the server.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    fetchTransactionSeriesWithTransactionSeriesFilter:
        (nonnull MNFTransactionSeriesFilter *)seriesFilter
                                       withCompletion:
                                           (nullable
                                                MNFTransactionSeriesCompletionHandler)
                                               completion;

    Swift

    class func fetchTransactionSeries(with seriesFilter: MNFTransactionSeriesFilter, withCompletion completion: MNFTransactionSeriesCompletionHandler? = nil) -> MNFJob

    Parameters

    seriesFilter

    The transaction series filter used to create the series.
    completion

    A completion block returning a transaction series and an error.

    Return Value

    An MNFJob containing a transaction series and an error.

  • @abstract Fetches a transaction series from the server.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    fetchTransactionSeriesWithTransactionSeriesFilter:
        (nonnull MNFTransactionSeriesFilter *)seriesFilter
                                          withInclude:
                                              (nullable NSArray *)include
                                        andCompletion:
                                            (nullable
                                                 MNFTransactionSeriesCompletionHandler)
                                                completion;

    Swift

    class func fetchTransactionSeries(with seriesFilter: MNFTransactionSeriesFilter, withInclude include: [Any]?, andCompletion completion: MNFTransactionSeriesCompletionHandler? = nil) -> MNFJob

    Parameters

    seriesFilter

    The transaction series filter used to create the series.
    include

    query parameter that tells which related resources should be included in the response as ‘included’ data. Supported resources are “Account” and “Merchant”, e.g. “Account,Merchant” to get both resources included
    completion

    A completion block returning a transaction series and an error.

    Return Value

    An MNFJob containing a transaction series and an error.