Structures

The following structures are available globally.

  • Undocumented

    See more

    Declaration

    Swift

    public struct Activity : Searchable, Hashable

  • Undocumented

    See more

    Declaration

    Swift

    public struct DataFileUploadContext : JSONEncodedBody

  • Undocumented

    See more

    Declaration

    Swift

    public struct DataFileUploadIndex : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserHeadunit : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserIntensityZone : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserIntensityZoneRange : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserPowerMeter : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserWorkoutDetails : Searchable

  • This is a view object related to activity data. It has a lot of possible fields, but most are only populated if a specific field is requested via the Activities API.

    Some fields are also sport specific - and will only be set on activities of the relevant sport type.

    See more

    Declaration

    Swift

    public struct UserWorkoutResult : Searchable

  • Altitude adjusted power

    See more

    Declaration

    Swift

    public struct UserWorkoutResultAlt : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserWorkoutResultBike : Searchable

  • By hour averages

    See more

    Declaration

    Swift

    public struct UserWorkoutResultByHour : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserWorkoutResultChannel : Searchable

  • Extended result set

    See more

    Declaration

    Swift

    public struct UserWorkoutResultExt : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserWorkoutResultExt2 : Searchable

  • Peak leg spring stiffness

    See more

    Declaration

    Swift

    public struct UserWorkoutResultPeakLss : Searchable

  • Peak pace

    See more

    Declaration

    Swift

    public struct UserWorkoutResultPeakPace : Searchable

  • Rating of a prescribed workout

    See more

    Declaration

    Swift

    public struct UserWorkoutResultRating : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserWorkoutResultTurbo : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserWorkoutResultTurboExt : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct Company : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PaymentVerification : JSONEncodedBody, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct Products : Codable, JSONEncodedBody

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserRoute : Searchable, JSONEncodedBody

  • Undocumented

    See more

    Declaration

    Swift

    public struct DateRange : Codable

  • Undocumented

    Declaration

    Swift

    public struct DayRange : Encodable

  • Representation of time as milliseconds.

    On its own, a Milliseconds value does not represent a unique point in time, or a span between times.

    See more

    Declaration

    Swift

    public struct Milliseconds : RawRepresentable, Hashable, CustomStringConvertible
    extension Milliseconds: ExpressibleByIntegerLiteral
    extension Milliseconds: SignedNumeric, Strideable, Equatable, Comparable
    extension Milliseconds: Codable

  • A structure that defines an ordering to be applied when returning a list of results.

    See more

    Declaration

    Swift

    public struct Order : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct SearchInput<Criteria> : JSONEncodedBody where Criteria : SearchInputCriteria

  • This is derived from the original VTeamMultiRidePeriod impl - it is used on aggregate reporting focused endpoints

    See more

    Declaration

    Swift

    public struct SearchInputReport : JSONEncodedBody, SearchInputCriteria

  • A collection of results for a search request.

    See more

    Declaration

    Swift

    public struct SearchResult<Result> where Result : Decodable
    extension SearchResult: RandomAccessCollection
    extension SearchResult: CustomDebugStringConvertible
    extension SearchResult: Decodable

  • A Search criteria for user routes.

    See more

    Declaration

    Swift

    public struct UserRouteSearch : SearchInputCriteria

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserWorkoutFileSearch : SearchInputCriteria

  • Returned by /rest/auth/terms/required

    See more

    Declaration

    Swift

    public struct TermsAndConditions : Codable, JSONEncodedBody

  • Undocumented

    See more

    Declaration

    Swift

    public struct UpdatedTerms : Codable, JSONEncodedBody

  • Undocumented

    See more

    Declaration

    Swift

    public struct PushRegistration : Codable, JSONEncodedBody

  • Response to ThirdPartyConnectionsView.registerDeviceWithThirdParty

    See more

    Declaration

    Swift

    public struct PushRegistrationResponse : Codable

  • Response from ThirdPartyConnectionsView.initializeThirdPartyConnection

    See more

    Declaration

    Swift

    public struct ThirdPartyInitializeResponse : Codable

  • Response to zone5.thirdPartyConnections.getDeprecated()

    See more

    Declaration

    Swift

    public struct UpgradeAvailableResponse : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct StringEncodedBody : JSONEncodedBody

  • Parameters that may be encoded as a URL query string, i.e. key=value&otherKey=otherValue.

    This structure can be used all request types. For requests that can take a request body (i.e. POST), the output of the encodedData() method is used. In instances where this is not the case, the description is appended to the endpoint URL as a query string.

    See more

    Declaration

    Swift

    public struct URLEncodedBody : RequestBody, CustomStringConvertible, ExpressibleByArrayLiteral, ExpressibleByDictionaryLiteral

  • Undocumented

    See more

    Declaration

    Swift

    public struct LoginResponse : Codable

  • OAuth token model returned by the server for accessToken requests and refreshAccessToken requests They are also constructed from LoginResponse These may be legacy TP OAuth tokens (which will not have a refreshToken) or a Cognito token. Cognito tokens will have refreshToken and expiresIn set

    See more

    Declaration

    Swift

    public struct OAuthToken : Codable, Equatable, AccessToken

  • OAuth token model returned by the server for gigya refresh token requests These OAuth tokens are Gigya tokens

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "Gigya is no longer supported. Use OAuthToken")
public struct OAuthTokenAlt : Codable, AccessToken

  • Undocumented

    See more

    Declaration

    Swift

    public struct RegisterUser : Codable, JSONEncodedBody

  • Model object representing a User

    See more

    Declaration

    Swift

    public struct User : Searchable, JSONEncodedBody

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserThresholdHeart : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserThresholdPace : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserThresholdPower : Searchable

  • Undocumented

    See more

    Declaration

    Swift

    public struct UsersPreferences : Codable, JSONEncodedBody