diff --git a/Sources/Bagbutik-Core/Models/DocumentLinks.swift b/Sources/Bagbutik-Core/Models/DocumentLinks.swift index 51fbe26bb..4af7c184d 100644 --- a/Sources/Bagbutik-Core/Models/DocumentLinks.swift +++ b/Sources/Bagbutik-Core/Models/DocumentLinks.swift @@ -1,6 +1,16 @@ import Foundation +/** + # DocumentLinks + Self-links to documents that can contain information for one or more resources. + + All the response data constitutes a *document*. + + Full documentation: + + */ public struct DocumentLinks: Codable, Sendable { + /// The link that produced the current document. public let itself: String public init(self itself: String) { diff --git a/Sources/Bagbutik-Core/Models/ErrorResponse.swift b/Sources/Bagbutik-Core/Models/ErrorResponse.swift index d8169334b..c1fffe688 100644 --- a/Sources/Bagbutik-Core/Models/ErrorResponse.swift +++ b/Sources/Bagbutik-Core/Models/ErrorResponse.swift @@ -1,6 +1,14 @@ import Foundation +/** + # ErrorResponse + The error details that an API returns in the response body whenever the API request isn’t successful. + + Full documentation: + + */ public struct ErrorResponse: Codable, Sendable, Error { + /// An array of one or more errors. public var errors: [Errors]? public init(errors: [Errors]? = nil) { diff --git a/Sources/Bagbutik-Core/Models/JsonPointer.swift b/Sources/Bagbutik-Core/Models/JsonPointer.swift index 14c2ef541..9a1e2a89e 100644 --- a/Sources/Bagbutik-Core/Models/JsonPointer.swift +++ b/Sources/Bagbutik-Core/Models/JsonPointer.swift @@ -1,6 +1,16 @@ import Foundation +/** + # JsonPointer + An object that contains the JSON pointer that indicates the location of the error. + + In some cases, the JSON pointer may indicate an element that isn’t in the request entity, but should be. For more information about JSON pointers, see the [RFC 6901](https://developer.apple.comhttps://tools.ietf.org/html/rfc6901) proposed standards document. + + Full documentation: + + */ public struct JsonPointer: Codable, Sendable { + /// A JSON pointer that indicates the location in the request entity where the error originates. public let pointer: String public init(pointer: String) { diff --git a/Sources/Bagbutik-Core/Models/PagedDocumentLinks.swift b/Sources/Bagbutik-Core/Models/PagedDocumentLinks.swift index 0c07bd1c4..55b17d7a2 100644 --- a/Sources/Bagbutik-Core/Models/PagedDocumentLinks.swift +++ b/Sources/Bagbutik-Core/Models/PagedDocumentLinks.swift @@ -1,8 +1,20 @@ import Foundation +/** + # PagedDocumentLinks + Links related to the response document, including paging links. + + All the response data constitutes multiple *documents.* + + Full documentation: + + */ public struct PagedDocumentLinks: Codable, Sendable { + /// The link to the first page of documents. public var first: String? + /// The link to the next page of documents. public var next: String? + /// The link that produced the current document. public let itself: String public init(first: String? = nil, diff --git a/Sources/Bagbutik-Core/Models/PagingInformation.swift b/Sources/Bagbutik-Core/Models/PagingInformation.swift index dbd27b3d4..f61d3b44f 100644 --- a/Sources/Bagbutik-Core/Models/PagingInformation.swift +++ b/Sources/Bagbutik-Core/Models/PagingInformation.swift @@ -1,6 +1,14 @@ import Foundation +/** + # PagingInformation + Paging information for data responses. + + Full documentation: + + */ public struct PagingInformation: Codable, Sendable { + /// The paging information details. public let paging: Paging public init(paging: Paging) { diff --git a/Sources/Bagbutik-Core/Models/Parameter.swift b/Sources/Bagbutik-Core/Models/Parameter.swift index 6e468f210..1734f0b33 100644 --- a/Sources/Bagbutik-Core/Models/Parameter.swift +++ b/Sources/Bagbutik-Core/Models/Parameter.swift @@ -1,6 +1,14 @@ import Foundation +/** + # Parameter + An object that contains the query parameter that produced the error. + + Full documentation: + + */ public struct Parameter: Codable, Sendable { + /// The query parameter that produced the error. public let parameter: String public init(parameter: String) { diff --git a/Sources/Bagbutik-Core/Models/RelationshipLinks.swift b/Sources/Bagbutik-Core/Models/RelationshipLinks.swift index 1e9d96a04..716642652 100644 --- a/Sources/Bagbutik-Core/Models/RelationshipLinks.swift +++ b/Sources/Bagbutik-Core/Models/RelationshipLinks.swift @@ -1,7 +1,16 @@ import Foundation +/** + # RelationshipLinks + Links related to the response document, including self links. + + Full documentation: + + */ public struct RelationshipLinks: Codable, Sendable { + /// The link to the related documents. public var related: String? + /// The link that produced the current document. public var itself: String? public init(related: String? = nil, diff --git a/Sources/Bagbutik-Core/Models/ResourceLinks.swift b/Sources/Bagbutik-Core/Models/ResourceLinks.swift index 8d1b22a53..3c8c716e5 100644 --- a/Sources/Bagbutik-Core/Models/ResourceLinks.swift +++ b/Sources/Bagbutik-Core/Models/ResourceLinks.swift @@ -1,6 +1,14 @@ import Foundation +/** + # ResourceLinks + Self-links to requested resources. + + Full documentation: + + */ public struct ResourceLinks: Codable, Sendable { + /// The link to the resource. public var itself: String? public init(self itself: String? = nil) { diff --git a/Sources/Bagbutik-Models/AppStore/AgeRatingDeclaration.swift b/Sources/Bagbutik-Models/AppStore/AgeRatingDeclaration.swift index d4579b865..f4c74c335 100644 --- a/Sources/Bagbutik-Models/AppStore/AgeRatingDeclaration.swift +++ b/Sources/Bagbutik-Models/AppStore/AgeRatingDeclaration.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # AgeRatingDeclaration + The data structure that represents an Age Rating Declarations resource. + + Full documentation: + + */ public struct AgeRatingDeclaration: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "ageRatingDeclarations" } + /// Attributes that describe this Age Rating Declarations resource. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AgeRatingDeclarationResponse.swift b/Sources/Bagbutik-Models/AppStore/AgeRatingDeclarationResponse.swift index b7160eb7c..65cb3734c 100644 --- a/Sources/Bagbutik-Models/AppStore/AgeRatingDeclarationResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AgeRatingDeclarationResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AgeRatingDeclarationResponse + A response that contains a single Age Rating Declarations resource. + + Full documentation: + + */ public struct AgeRatingDeclarationResponse: Codable, Sendable { + /// The data structure that represents the Age Rating Declarations resource. public let data: AgeRatingDeclaration + /// Navigational links including the self-link and links to the related data. public let links: DocumentLinks public init(data: AgeRatingDeclaration, diff --git a/Sources/Bagbutik-Models/AppStore/AgeRatingDeclarationUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AgeRatingDeclarationUpdateRequest.swift index 84416180f..011e7f215 100644 --- a/Sources/Bagbutik-Models/AppStore/AgeRatingDeclarationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AgeRatingDeclarationUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AgeRatingDeclarationUpdateRequest + The request body you use to update an Age Rating Declaration. + + Full documentation: + + */ public struct AgeRatingDeclarationUpdateRequest: Codable, Sendable, RequestBody { + /// The data element of the request body. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/App.swift b/Sources/Bagbutik-Models/AppStore/App.swift index 59f9f83b0..ef2430437 100644 --- a/Sources/Bagbutik-Models/AppStore/App.swift +++ b/Sources/Bagbutik-Models/AppStore/App.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # App + The data structure that represents an Apps resource. + + Full documentation: + + */ public struct App: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "apps" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2.swift b/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2.swift index 3ec6f82e9..b8ff6a54b 100644 --- a/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2.swift +++ b/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppAvailabilityV2 + The data structure that represents an app availability resource. + + Full documentation: + + */ public struct AppAvailabilityV2: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2CreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2CreateRequest.swift index 3ff3ee2b3..81ae9e69a 100644 --- a/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2CreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2CreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppAvailabilityV2CreateRequest + The request body you use to create an app availability. + + Full documentation: + + */ public struct AppAvailabilityV2CreateRequest: Codable, Sendable, RequestBody { public let data: Data public var included: [TerritoryAvailabilityInlineCreate]? diff --git a/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2Response.swift b/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2Response.swift index 65b6955c5..4f06d0c4b 100644 --- a/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2Response.swift +++ b/Sources/Bagbutik-Models/AppStore/AppAvailabilityV2Response.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppAvailabilityV2Response + A response that contains a single app availability resource. + + Full documentation: + + */ public struct AppAvailabilityV2Response: Codable, Sendable { public let data: AppAvailabilityV2 public var included: [TerritoryAvailability]? diff --git a/Sources/Bagbutik-Models/AppStore/AppBetaTestersLinkagesRequest.swift b/Sources/Bagbutik-Models/AppStore/AppBetaTestersLinkagesRequest.swift index cce211e10..6c879deed 100644 --- a/Sources/Bagbutik-Models/AppStore/AppBetaTestersLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppBetaTestersLinkagesRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppBetaTestersLinkagesRequest + A request body you use to remove beta testers from an app. + + Full documentation: + + */ public struct AppBetaTestersLinkagesRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. public let data: [Data] public init(data: [Data]) { diff --git a/Sources/Bagbutik-Models/AppStore/AppCategoriesResponse.swift b/Sources/Bagbutik-Models/AppStore/AppCategoriesResponse.swift index 8399b8c5a..f98effafd 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCategoriesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCategoriesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCategoriesResponse + A response that contains a list of App Category resources. + + Full documentation: + + */ public struct AppCategoriesResponse: Codable, Sendable, PagedResponse { public typealias Data = AppCategory diff --git a/Sources/Bagbutik-Models/AppStore/AppCategory.swift b/Sources/Bagbutik-Models/AppStore/AppCategory.swift index bed533afb..2543f9ebe 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCategory.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCategory.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCategory + The data structure that represent an App Categories resource. + + Full documentation: + + */ public struct AppCategory: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppCategoryResponse.swift b/Sources/Bagbutik-Models/AppStore/AppCategoryResponse.swift index dd508f314..478126d67 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCategoryResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCategoryResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCategoryResponse + A response that contains a single App Categories resource. + + Full documentation: + + */ public struct AppCategoryResponse: Codable, Sendable { public let data: AppCategory public var included: [AppCategory]? diff --git a/Sources/Bagbutik-Models/AppStore/AppClip.swift b/Sources/Bagbutik-Models/AppStore/AppClip.swift index 37c19197a..b7b5e5fce 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClip.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClip.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppClip + The data structure that represents an App Clips resource. + + Full documentation: + + */ public struct AppClip: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an App Clips resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appClips" } + /// The attributes that describe the App Clips resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperience.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperience.swift index a490a146c..940502d6b 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperience.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperience.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperience + The data structure that represents an Advanced App Clip Experiences resource. + + Full documentation: + + */ public struct AppClipAdvancedExperience: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an Advanced App Clip Experiences resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appClipAdvancedExperiences" } + /// The attributes that describe the Advanced App Clip Experiences resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceCreateRequest.swift index c5525fbd4..ab0fc21b2 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceCreateRequest.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperienceCreateRequest + The request body you use to create an advanced App Clip experience. + + Full documentation: + + */ public struct AppClipAdvancedExperienceCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data + /// The relationship data to include in the response. public var included: [AppClipAdvancedExperienceLocalizationInlineCreate]? public init(data: Data, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImage.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImage.swift index a984c6a13..c7a289ca6 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImage.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImage.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperienceImage + The data structure that represents an image that appears on the App Clip card for an advanced App Clip experience. + + Full documentation: + + */ public struct AppClipAdvancedExperienceImage: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an Advanced App Clip Experience Images resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appClipAdvancedExperienceImages" } + /// The attributes that describe the Advanced App Clip Experience Images resource. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageCreateRequest.swift index ef5bcfac4..eab099430 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperienceImageCreateRequest + The request body you use to reserve an image asset for an advanced App Clip experience. + + Full documentation: + + */ public struct AppClipAdvancedExperienceImageCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageResponse.swift index 76a82992b..bd87e75fb 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperienceImageResponse + A response that contains a single Advanced App Clip Experience Images resource. + + Full documentation: + + */ public struct AppClipAdvancedExperienceImageResponse: Codable, Sendable { + /// The resource data. public let data: AppClipAdvancedExperienceImage + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppClipAdvancedExperienceImage, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageUpdateRequest.swift index 25c40fb54..42dd429cc 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceImageUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperienceImageUpdateRequest + The request body you use to commit the image asset for an advanced App Clip experience. + + Full documentation: + + */ public struct AppClipAdvancedExperienceImageUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceLocalization.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceLocalization.swift index 78d248726..f5e7b8259 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceLocalization.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceLocalization.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperienceLocalization + The data structure that represents the Advanced App Clip Localizations resource. + + Full documentation: + + */ public struct AppClipAdvancedExperienceLocalization: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an Advanced App Clip Experience Localizations resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appClipAdvancedExperienceLocalizations" } + /// The attributes that describe the Advanced App Clip Experience Localizations resource. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceLocalizationInlineCreate.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceLocalizationInlineCreate.swift index 6f89079d0..e9801356a 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceLocalizationInlineCreate.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceLocalizationInlineCreate.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperienceLocalizationInlineCreate + The data structure that represents an Advanced App Clip Experience Localization Inline Creates resource. + + Full documentation: + + */ public struct AppClipAdvancedExperienceLocalizationInlineCreate: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an Advanced App Clip Experience Localization Inline Creates resource. public var id: String? + /// The resource type. public var type: String { "appClipAdvancedExperienceLocalizations" } + /// The attributes that describe the Advanced App Clip Experience Localization Inline Creates resource. public var attributes: Attributes? public init(id: String? = nil, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceResponse.swift index 794d46076..04d2b5e8e 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperienceResponse + A response that contains a single Advanced App Clip Experiences resource. + + Full documentation: + + */ public struct AppClipAdvancedExperienceResponse: Codable, Sendable { + /// The resource data. public let data: AppClipAdvancedExperience + /// The requested relationship data. public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppClipAdvancedExperience, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceUpdateRequest.swift index 385b07110..5860b71fa 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperienceUpdateRequest.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperienceUpdateRequest + The request body you use to update an advanced App Clip experience. + + Full documentation: + + */ public struct AppClipAdvancedExperienceUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data + /// The relationship data to include in the response. public var included: [AppClipAdvancedExperienceLocalizationInlineCreate]? public init(data: Data, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperiencesResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperiencesResponse.swift index 69b6a7a73..1bdd27708 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperiencesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAdvancedExperiencesResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppClipAdvancedExperiencesResponse + A response that contains a list of Advanced App Clip Experiences resources. + + Full documentation: + + */ public struct AppClipAdvancedExperiencesResponse: Codable, Sendable, PagedResponse { public typealias Data = AppClipAdvancedExperience + /// The resource data. public let data: [AppClipAdvancedExperience] + /// The requested relationship data. public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [AppClipAdvancedExperience], diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetail.swift b/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetail.swift index 22ed75659..ef3dc58a0 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetail.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetail.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppClipAppStoreReviewDetail + The data structure that represents an App Clip App Store Review Details resource. + + Full documentation: + + */ public struct AppClipAppStoreReviewDetail: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an App Clip App Store Review Details resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appClipAppStoreReviewDetails" } + /// The attributes that describe the App Clip App Store Review Details resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailCreateRequest.swift index 848d6882e..40a98aff1 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipAppStoreReviewDetailCreateRequest + The request body you use to create an App Clip App Store Review Detail. + + Full documentation: + + */ public struct AppClipAppStoreReviewDetailCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailResponse.swift index 91e5d1518..955173b75 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # AppClipAppStoreReviewDetailResponse + A response that contains a single App Clip App Store Review Details resource. + + Full documentation: + + */ public struct AppClipAppStoreReviewDetailResponse: Codable, Sendable { + /// The resource data. public let data: AppClipAppStoreReviewDetail + /// The requested relationship data. public var included: [AppClipDefaultExperience]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppClipAppStoreReviewDetail, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailUpdateRequest.swift index 32f52c96a..fc794de21 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipAppStoreReviewDetailUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipAppStoreReviewDetailUpdateRequest + The request body you use to update App Clip information that you provide to App Store Review. + + Full documentation: + + */ public struct AppClipAppStoreReviewDetailUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperience.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperience.swift index cdfd3acd9..2f52a5fc2 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperience.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperience.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperience + The data structure that represents a Default App Clip Experiences resource. + + Full documentation: + + */ public struct AppClipDefaultExperience: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Default App Clip Experiences resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appClipDefaultExperiences" } + /// The attributes that describe the Default App Clip Experiences resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceCreateRequest.swift index 8e3f526ed..5fafc8f69 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperienceCreateRequest + The request body you use to create a default App Clip experience. + + Full documentation: + + */ public struct AppClipDefaultExperienceCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalization.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalization.swift index b7387a550..4e0e75fbf 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalization.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalization.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperienceLocalization + The data structure that represents a Default App Clip Experience Localizations resource. + + Full documentation: + + */ public struct AppClipDefaultExperienceLocalization: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Default App Clip Experience Localizations resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appClipDefaultExperienceLocalizations" } + /// The attributes that describe the Default App Clip Experience Localizations resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationCreateRequest.swift index 01f7b3799..1c945550a 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperienceLocalizationCreateRequest + The request body you use to create a Default App Clip Experience Localization. + + Full documentation: + + */ public struct AppClipDefaultExperienceLocalizationCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationResponse.swift index 83e4ec2be..d56fc8d44 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperienceLocalizationResponse + A response that contains a single Default App Clip Experience Localizations resource. + + Full documentation: + + */ public struct AppClipDefaultExperienceLocalizationResponse: Codable, Sendable { + /// The resource data. public let data: AppClipDefaultExperienceLocalization + /// The requested relationship data. public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppClipDefaultExperienceLocalization, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationUpdateRequest.swift index dcdec1766..c9a326ad8 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperienceLocalizationUpdateRequest + The request body you use to update a Default App Clip Experiences resource. + + Full documentation: + + */ public struct AppClipDefaultExperienceLocalizationUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationsResponse.swift index 3ed4d3d42..708f990f3 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceLocalizationsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperienceLocalizationsResponse + A response that contains a list of Default App Clip Experience Localizations resources. + + Full documentation: + + */ public struct AppClipDefaultExperienceLocalizationsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppClipDefaultExperienceLocalization + /// The resource data. public let data: [AppClipDefaultExperienceLocalization] + /// The requested relationship data. public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [AppClipDefaultExperienceLocalization], diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageRequest.swift index bd59032af..e1ddcadc6 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageRequest + The request body you use to relate a released App Store version with a default App Clip experience. + + Full documentation: + + */ public struct AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. @NullCodable public var data: Data? public init(data: Data? = nil) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageResponse.swift index 61f08af90..9fc3c4f3c 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageResponse + A response that contains the ID of a single related App Store Versions resource. + + Full documentation: + + */ public struct AppClipDefaultExperienceReleaseWithAppStoreVersionLinkageResponse: Codable, Sendable { + /// The object types and IDs of the related resources. public let data: Data + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: Data, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceResponse.swift index 80d7514bb..a1303691b 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperienceResponse + A response that contains a single Default App Clip Experiences resource. + + Full documentation: + + */ public struct AppClipDefaultExperienceResponse: Codable, Sendable { + /// The resource data. public let data: AppClipDefaultExperience + /// The requested relationship data. public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppClipDefaultExperience, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceUpdateRequest.swift index 8255c10de..c8cd26d16 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperienceUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperienceUpdateRequest + The request body you use to update a default App Clip experience. + + Full documentation: + + */ public struct AppClipDefaultExperienceUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperiencesResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperiencesResponse.swift index e49d7971c..813eb758c 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperiencesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDefaultExperiencesResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppClipDefaultExperiencesResponse + A response that contains a list of Default App Clip Experiences resources. + + Full documentation: + + */ public struct AppClipDefaultExperiencesResponse: Codable, Sendable, PagedResponse { public typealias Data = AppClipDefaultExperience + /// The resource data. public let data: [AppClipDefaultExperience] + /// The requested relationship data. public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [AppClipDefaultExperience], diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDomainStatus.swift b/Sources/Bagbutik-Models/AppStore/AppClipDomainStatus.swift index 6248d3c3e..ed7ca509b 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDomainStatus.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDomainStatus.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # AppClipDomainStatus + The data structure that represents the App Clip Domain Statuses resource. + + Full documentation: + + */ public struct AppClipDomainStatus: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an App Clip Domain Statuses resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appClipDomainStatuses" } + /// The attributes that describe the App Clip Domain Statuses resource. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipDomainStatusResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipDomainStatusResponse.swift index c1a4b21a5..03c891bdc 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipDomainStatusResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipDomainStatusResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AppClipDomainStatusResponse + A response that contains a single App Clip Domain Statuses resource. + + Full documentation: + + */ public struct AppClipDomainStatusResponse: Codable, Sendable { + /// The resource data. public let data: AppClipDomainStatus + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppClipDomainStatus, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipHeaderImage.swift b/Sources/Bagbutik-Models/AppStore/AppClipHeaderImage.swift index 9c12d5b09..e72126fa7 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipHeaderImage.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipHeaderImage.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppClipHeaderImage + The data structure that represents the image that appears on the App Clip card of a default App Clip experience. + + Full documentation: + + */ public struct AppClipHeaderImage: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an App Clip Header Images resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appClipHeaderImages" } + /// The attributes that describe the App Clip Header Images resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageCreateRequest.swift index 19f879d5c..167a93755 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipHeaderImageCreateRequest + The request body you use to reserve an image asset that appears on the App Clip card of a default App Clip experience. + + Full documentation: + + */ public struct AppClipHeaderImageCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageResponse.swift index a89788517..b48639f9e 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # AppClipHeaderImageResponse + A response that contains a single App Clip Header Images resource. + + Full documentation: + + */ public struct AppClipHeaderImageResponse: Codable, Sendable { + /// The resource data. public let data: AppClipHeaderImage + /// The requested relationship data. public var included: [AppClipDefaultExperienceLocalization]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppClipHeaderImage, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageUpdateRequest.swift index c26b2220a..4fc4bdde9 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipHeaderImageUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppClipHeaderImageUpdateRequest + The request body you use to commit the image asset for a default App Clip experience. + + Full documentation: + + */ public struct AppClipHeaderImageUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppClipResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipResponse.swift index 136b8aed4..ad72e336f 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # AppClipResponse + A response that contains a single App Clips resource. + + Full documentation: + + */ public struct AppClipResponse: Codable, Sendable { + /// The resource data. public let data: AppClip + /// The requested relationship data. public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppClip, diff --git a/Sources/Bagbutik-Models/AppStore/AppClipsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppClipsResponse.swift index 1c6a7fd77..2c18d5a1e 100644 --- a/Sources/Bagbutik-Models/AppStore/AppClipsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppClipsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppClipsResponse + A response that contains a list of App Clips resources. + + Full documentation: + + */ public struct AppClipsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppClip + /// The resource data. public let data: [AppClip] + /// The requested relationship data. public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [AppClip], diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPage.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPage.swift index d268fb737..3e10dc3bd 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPage.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPage.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPage + The data structure that represents an app custom product page resource. + + Full documentation: + + */ public struct AppCustomProductPage: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageCreateRequest.swift index fa540fb58..06aa1ae6d 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageCreateRequest + The request body you use to create an app custom product page. + + Full documentation: + + */ public struct AppCustomProductPageCreateRequest: Codable, Sendable, RequestBody { public let data: Data public var included: [Included]? diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalization.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalization.swift index 9990eb921..1188f6964 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalization.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalization.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageLocalization + The data structure that represents an app custom product page localization resource. + + Full documentation: + + */ public struct AppCustomProductPageLocalization: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationCreateRequest.swift index a1b782659..5488e3f64 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageLocalizationCreateRequest + The request body you use to create an app custom product page localization. + + Full documentation: + + */ public struct AppCustomProductPageLocalizationCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationInlineCreate.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationInlineCreate.swift index b884436b5..742b28aa1 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationInlineCreate.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationInlineCreate.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageLocalizationInlineCreate + The data structure that represents an app custom product page localization inline creates resource. + + Full documentation: + + */ public struct AppCustomProductPageLocalizationInlineCreate: Codable, Sendable, Identifiable { public var id: String? public var type: String { "appCustomProductPageLocalizations" } diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationResponse.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationResponse.swift index 982e18084..2650ff05e 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageLocalizationResponse + A response that contains a single app custom product page resource. + + Full documentation: + + */ public struct AppCustomProductPageLocalizationResponse: Codable, Sendable { public let data: AppCustomProductPageLocalization public var included: [Included]? diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationUpdateRequest.swift index 126cf0492..58f8b63d5 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageLocalizationUpdateRequest + The request body you use to update an app custom product page localization. + + Full documentation: + + */ public struct AppCustomProductPageLocalizationUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationsResponse.swift index 527bcc061..d611570d8 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageLocalizationsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageLocalizationsResponse + A response that contains a list of alternative distribution package variant resources. + + Full documentation: + + */ public struct AppCustomProductPageLocalizationsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppCustomProductPageLocalization diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageResponse.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageResponse.swift index 1b123d7c4..ede29ad61 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageResponse + A response that contains a single app custom product page resource. + + Full documentation: + + */ public struct AppCustomProductPageResponse: Codable, Sendable { public let data: AppCustomProductPage public var included: [Included]? diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageUpdateRequest.swift index e9286bd20..5c9ca2b00 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageUpdateRequest + The request body you use to update an app custom product page. + + Full documentation: + + */ public struct AppCustomProductPageUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersion.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersion.swift index df2cd5cf1..381a6184d 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersion.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersion.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageVersion + The data structure that represents an app custom product page version resource. + + Full documentation: + + */ public struct AppCustomProductPageVersion: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionCreateRequest.swift index e83e712b7..1d1b5708f 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageVersionCreateRequest + The request body you use to create an app custom product page version. + + Full documentation: + + */ public struct AppCustomProductPageVersionCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionInlineCreate.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionInlineCreate.swift index b9c073e15..dc0db0e6c 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionInlineCreate.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionInlineCreate.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageVersionInlineCreate + The data structure that represents an app custom product page version inline create resource. + + Full documentation: + + */ public struct AppCustomProductPageVersionInlineCreate: Codable, Sendable, Identifiable { public var id: String? public var type: String { "appCustomProductPageVersions" } diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionResponse.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionResponse.swift index 491f94c31..a5e0f6cfc 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageVersionResponse + A response that contains a single app custom product page resource. + + Full documentation: + + */ public struct AppCustomProductPageVersionResponse: Codable, Sendable { public let data: AppCustomProductPageVersion public var included: [Included]? diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionUpdateRequest.swift index 979abf914..480876d91 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageVersionUpdateRequest + The request body you use to update an app custom product page version. + + Full documentation: + + */ public struct AppCustomProductPageVersionUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionsResponse.swift index ee7d7b9a3..74c069cd7 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPageVersionsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPageVersionsResponse + A response that contains a list of app customer product page version resources. + + Full documentation: + + */ public struct AppCustomProductPageVersionsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppCustomProductPageVersion diff --git a/Sources/Bagbutik-Models/AppStore/AppCustomProductPagesResponse.swift b/Sources/Bagbutik-Models/AppStore/AppCustomProductPagesResponse.swift index a662342de..56520d76d 100644 --- a/Sources/Bagbutik-Models/AppStore/AppCustomProductPagesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppCustomProductPagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppCustomProductPagesResponse + A response that contains a list of app custom product page resources. + + Full documentation: + + */ public struct AppCustomProductPagesResponse: Codable, Sendable, PagedResponse { public typealias Data = AppCustomProductPage diff --git a/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclaration.swift b/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclaration.swift index 24aa8cfe0..ee93de326 100644 --- a/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclaration.swift +++ b/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclaration.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppEncryptionDeclaration + The data structure that represents an App Encryption Declarations resource. + + Full documentation: + + */ public struct AppEncryptionDeclaration: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appEncryptionDeclarations" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationBuildsLinkagesRequest.swift b/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationBuildsLinkagesRequest.swift index 669ba2fe4..8d3872275 100644 --- a/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationBuildsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationBuildsLinkagesRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppEncryptionDeclarationBuildsLinkagesRequest + A request body you use to add builds to an app encryption declaration. + + Full documentation: + + */ public struct AppEncryptionDeclarationBuildsLinkagesRequest: Codable, Sendable, RequestBody { + /// The object types and IDs of the related resources. public let data: [Data] public init(data: [Data]) { diff --git a/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationCreateRequest.swift index d2ee85fcd..9aeefd144 100644 --- a/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppEncryptionDeclarationCreateRequest + The request body you use to create an app encryption declaration. + + Full documentation: + + */ public struct AppEncryptionDeclarationCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationResponse.swift b/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationResponse.swift index 21f6a6724..9ea62c9cd 100644 --- a/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AppEncryptionDeclarationResponse + A response that contains a single App Encryption Declarations resource. + + Full documentation: + + */ public struct AppEncryptionDeclarationResponse: Codable, Sendable { + /// The resource data. public let data: AppEncryptionDeclaration public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppEncryptionDeclaration, diff --git a/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationsResponse.swift index 3204cdf79..b976aa0f2 100644 --- a/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppEncryptionDeclarationsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # AppEncryptionDeclarationsResponse + A response that contains a list of App Encryption Declaration resources. + + Full documentation: + + */ public struct AppEncryptionDeclarationsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppEncryptionDeclaration + /// The resource data. public let data: [AppEncryptionDeclaration] public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [AppEncryptionDeclaration], diff --git a/Sources/Bagbutik-Models/AppStore/AppInfo.swift b/Sources/Bagbutik-Models/AppStore/AppInfo.swift index 3c3595352..f842fb136 100644 --- a/Sources/Bagbutik-Models/AppStore/AppInfo.swift +++ b/Sources/Bagbutik-Models/AppStore/AppInfo.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # AppInfo + The data structure that represent an App Infos resource. + + Full documentation: + + */ public struct AppInfo: Codable, Sendable, Identifiable { + /// An opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appInfos" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppInfoLocalization.swift b/Sources/Bagbutik-Models/AppStore/AppInfoLocalization.swift index 44dd7f024..3a1af30e1 100644 --- a/Sources/Bagbutik-Models/AppStore/AppInfoLocalization.swift +++ b/Sources/Bagbutik-Models/AppStore/AppInfoLocalization.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppInfoLocalization + The data structure that represent an App Info Localizations resource. + + Full documentation: + + */ public struct AppInfoLocalization: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationCreateRequest.swift index d32e62459..75b7cf8f6 100644 --- a/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppInfoLocalizationCreateRequest + The request body you use to create an App Info Localization. + + Full documentation: + + */ public struct AppInfoLocalizationCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationResponse.swift b/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationResponse.swift index 58eb4b7d0..50a8aa444 100644 --- a/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppInfoLocalizationResponse + A response that contains a single App Info Localizations resource. + + Full documentation: + + */ public struct AppInfoLocalizationResponse: Codable, Sendable { public let data: AppInfoLocalization public var included: [AppInfo]? diff --git a/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationUpdateRequest.swift index 424b02177..85ed3b1dd 100644 --- a/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppInfoLocalizationUpdateRequest + The request body you use to update an App Info Localization. + + Full documentation: + + */ public struct AppInfoLocalizationUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationsResponse.swift index 2ba12ded6..847995a42 100644 --- a/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppInfoLocalizationsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppInfoLocalizationsResponse + A response that contains a list of AppInfoLocalizations resources. + + Full documentation: + + */ public struct AppInfoLocalizationsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppInfoLocalization diff --git a/Sources/Bagbutik-Models/AppStore/AppInfoResponse.swift b/Sources/Bagbutik-Models/AppStore/AppInfoResponse.swift index 142da8cb9..d9ba22044 100644 --- a/Sources/Bagbutik-Models/AppStore/AppInfoResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppInfoResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AppInfoResponse + A response that contains a single App Infos resource. + + Full documentation: + + */ public struct AppInfoResponse: Codable, Sendable { + /// The resource data. public let data: AppInfo public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppInfo, diff --git a/Sources/Bagbutik-Models/AppStore/AppInfoUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppInfoUpdateRequest.swift index 9364429a8..9538857b1 100644 --- a/Sources/Bagbutik-Models/AppStore/AppInfoUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppInfoUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppInfoUpdateRequest + The request body you use to update an App Info. + + Full documentation: + + */ public struct AppInfoUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppInfosResponse.swift b/Sources/Bagbutik-Models/AppStore/AppInfosResponse.swift index 6671dea28..ff2985b0b 100644 --- a/Sources/Bagbutik-Models/AppStore/AppInfosResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppInfosResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # AppInfosResponse + A response that contains a list of App Info resources. + + Full documentation: + + */ public struct AppInfosResponse: Codable, Sendable, PagedResponse { public typealias Data = AppInfo + /// The resource data. public let data: [AppInfo] public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [AppInfo], diff --git a/Sources/Bagbutik-Models/AppStore/AppMediaAssetState.swift b/Sources/Bagbutik-Models/AppStore/AppMediaAssetState.swift index 45309dc1a..ba777fc65 100644 --- a/Sources/Bagbutik-Models/AppStore/AppMediaAssetState.swift +++ b/Sources/Bagbutik-Models/AppStore/AppMediaAssetState.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppMediaAssetState + The state of an app or media upload, including any errors and warnings. + + Full documentation: + + */ public struct AppMediaAssetState: Codable, Sendable { public var errors: [AppMediaStateError]? public var state: State? diff --git a/Sources/Bagbutik-Models/AppStore/AppMediaStateError.swift b/Sources/Bagbutik-Models/AppStore/AppMediaStateError.swift index da93ffdf2..47ba7cda7 100644 --- a/Sources/Bagbutik-Models/AppStore/AppMediaStateError.swift +++ b/Sources/Bagbutik-Models/AppStore/AppMediaStateError.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppMediaStateError + An error code and description. + + Full documentation: + + */ public struct AppMediaStateError: Codable, Sendable { public var code: String? public var description: String? diff --git a/Sources/Bagbutik-Models/AppStore/AppPreOrder.swift b/Sources/Bagbutik-Models/AppStore/AppPreOrder.swift index 9a620146b..2d1098107 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreOrder.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreOrder.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreOrder + The data structure that represent an App Pre Orders resource. + + Full documentation: + + */ public struct AppPreOrder: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppPreOrderCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppPreOrderCreateRequest.swift index bc8f1614b..407db8648 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreOrderCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreOrderCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreOrderCreateRequest + The request body you use to create an App Pre-Order. + + Full documentation: + + */ public struct AppPreOrderCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppPreOrderResponse.swift b/Sources/Bagbutik-Models/AppStore/AppPreOrderResponse.swift index 3943a3f3c..5828b3ffd 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreOrderResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreOrderResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreOrderResponse + A response that contains a single App Pre-Orders resource. + + Full documentation: + + */ public struct AppPreOrderResponse: Codable, Sendable { public let data: AppPreOrder public var included: [App]? diff --git a/Sources/Bagbutik-Models/AppStore/AppPreOrderUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppPreOrderUpdateRequest.swift index 0382f32d5..326887a25 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreOrderUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreOrderUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreOrderUpdateRequest + The request body you use to update an App Pre-Order. + + Full documentation: + + */ public struct AppPreOrderUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppPreview.swift b/Sources/Bagbutik-Models/AppStore/AppPreview.swift index 7849cc5c3..96cb7f620 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreview.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreview.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreview + The data structure that represent an App Previews resource. + + Full documentation: + + */ public struct AppPreview: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppPreviewCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppPreviewCreateRequest.swift index c9a32549f..6f9b18851 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreviewCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreviewCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreviewCreateRequest + The request body you use to create an App Preview. + + Full documentation: + + */ public struct AppPreviewCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppPreviewResponse.swift b/Sources/Bagbutik-Models/AppStore/AppPreviewResponse.swift index 6eb18523c..692d48470 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreviewResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreviewResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreviewResponse + A response that contains a single App Previews resource. + + Full documentation: + + */ public struct AppPreviewResponse: Codable, Sendable { public let data: AppPreview public var included: [AppPreviewSet]? diff --git a/Sources/Bagbutik-Models/AppStore/AppPreviewSet.swift b/Sources/Bagbutik-Models/AppStore/AppPreviewSet.swift index 47e0d426c..d0a7e05e0 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreviewSet.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreviewSet.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreviewSet + The data structure that represent an App Preview Sets resource. + + Full documentation: + + */ public struct AppPreviewSet: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppPreviewSetAppPreviewsLinkagesRequest.swift b/Sources/Bagbutik-Models/AppStore/AppPreviewSetAppPreviewsLinkagesRequest.swift index cc5803df0..9caecd977 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreviewSetAppPreviewsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreviewSetAppPreviewsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreviewSetAppPreviewsLinkagesRequest + A request body you use to reorder the app previews in a preview set. + + Full documentation: + + */ public struct AppPreviewSetAppPreviewsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/AppStore/AppPreviewSetAppPreviewsLinkagesResponse.swift b/Sources/Bagbutik-Models/AppStore/AppPreviewSetAppPreviewsLinkagesResponse.swift index e6ce9d6f0..659124ca3 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreviewSetAppPreviewsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreviewSetAppPreviewsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreviewSetAppPreviewsLinkagesResponse + A response body that contains a list of related resource IDs. + + Full documentation: + + */ public struct AppPreviewSetAppPreviewsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/AppStore/AppPreviewSetCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppPreviewSetCreateRequest.swift index 32882d9d8..e08f90ed8 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreviewSetCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreviewSetCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreviewSetCreateRequest + The request body you use to create an App Preview Set. + + Full documentation: + + */ public struct AppPreviewSetCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppPreviewSetResponse.swift b/Sources/Bagbutik-Models/AppStore/AppPreviewSetResponse.swift index 0edc4f8ee..da19935c5 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreviewSetResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreviewSetResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreviewSetResponse + A response that contains a single App Preview Sets resource. + + Full documentation: + + */ public struct AppPreviewSetResponse: Codable, Sendable { public let data: AppPreviewSet public var included: [Included]? diff --git a/Sources/Bagbutik-Models/AppStore/AppPreviewSetsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppPreviewSetsResponse.swift index e1b818ebc..d011975ff 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreviewSetsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreviewSetsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreviewSetsResponse + A response that contains a list of App Preview Set resources. + + Full documentation: + + */ public struct AppPreviewSetsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppPreviewSet diff --git a/Sources/Bagbutik-Models/AppStore/AppPreviewUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppPreviewUpdateRequest.swift index 79c46be27..866ad0070 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreviewUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreviewUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreviewUpdateRequest + The request body you use to update an App Preview. + + Full documentation: + + */ public struct AppPreviewUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppPreviewsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppPreviewsResponse.swift index 1b92d281a..45f038223 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPreviewsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPreviewsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPreviewsResponse + A response that contains a list of App Preview resources. + + Full documentation: + + */ public struct AppPreviewsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppPreview diff --git a/Sources/Bagbutik-Models/AppStore/AppPricePointV3.swift b/Sources/Bagbutik-Models/AppStore/AppPricePointV3.swift index 9815e139c..b6f7823db 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPricePointV3.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPricePointV3.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPricePointV3 + The data structure that represents an App Price Point V3 resource. + + Full documentation: + + */ public struct AppPricePointV3: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppPriceV2InlineCreate.swift b/Sources/Bagbutik-Models/AppStore/AppPriceV2InlineCreate.swift index 9964a3fa4..c1bdca094 100644 --- a/Sources/Bagbutik-Models/AppStore/AppPriceV2InlineCreate.swift +++ b/Sources/Bagbutik-Models/AppStore/AppPriceV2InlineCreate.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppPriceV2InlineCreate + The data structure that represents a App Price V2 Inline Create resource. + + Full documentation: + + */ public struct AppPriceV2InlineCreate: Codable, Sendable, Identifiable { public var id: String? public var type: String { "appPrices" } diff --git a/Sources/Bagbutik-Models/AppStore/AppResponse.swift b/Sources/Bagbutik-Models/AppStore/AppResponse.swift index 9ab0d45c2..d6d8ec517 100644 --- a/Sources/Bagbutik-Models/AppStore/AppResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AppResponse + A response that contains a single Apps resource. + + Full documentation: + + */ public struct AppResponse: Codable, Sendable { + /// The resource data. public let data: App public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: App, diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshot.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshot.swift index 3820f5180..b5ed21886 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshot.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshot.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshot + The data structure that represent an App Screenshots resource. + + Full documentation: + + */ public struct AppScreenshot: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshotCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshotCreateRequest.swift index ab7d5ed5c..833b26457 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshotCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshotCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshotCreateRequest + The request body you use to create an App Screenshot. + + Full documentation: + + */ public struct AppScreenshotCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshotResponse.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshotResponse.swift index c6a9b2095..703673ba2 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshotResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshotResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshotResponse + A response that contains a single App Screenshots resource. + + Full documentation: + + */ public struct AppScreenshotResponse: Codable, Sendable { public let data: AppScreenshot public var included: [AppScreenshotSet]? diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshotSet.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshotSet.swift index ebd14c48c..876ae3401 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshotSet.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshotSet.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshotSet + The data structure that represent an app screenshot set resource. + + Full documentation: + + */ public struct AppScreenshotSet: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshotSetAppScreenshotsLinkagesRequest.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshotSetAppScreenshotsLinkagesRequest.swift index 74e7f28a4..285eb4ae7 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshotSetAppScreenshotsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshotSetAppScreenshotsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshotSetAppScreenshotsLinkagesRequest + A request body you use to reorder the screenshots in a screenshot set. + + Full documentation: + + */ public struct AppScreenshotSetAppScreenshotsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshotSetAppScreenshotsLinkagesResponse.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshotSetAppScreenshotsLinkagesResponse.swift index 6def017c2..9b28f68a2 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshotSetAppScreenshotsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshotSetAppScreenshotsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshotSetAppScreenshotsLinkagesResponse + A response body that contains a list of related resource IDs. + + Full documentation: + + */ public struct AppScreenshotSetAppScreenshotsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshotSetCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshotSetCreateRequest.swift index 9de485e3b..941c84235 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshotSetCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshotSetCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshotSetCreateRequest + The request body you use to create an app screenshot set. + + Full documentation: + + */ public struct AppScreenshotSetCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshotSetResponse.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshotSetResponse.swift index 60a1111c2..7ca2a05eb 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshotSetResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshotSetResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshotSetResponse + A response that contains a single app screenshot set resource. + + Full documentation: + + */ public struct AppScreenshotSetResponse: Codable, Sendable { public let data: AppScreenshotSet public var included: [Included]? diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshotSetsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshotSetsResponse.swift index 38aa9d7a5..80f3d844f 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshotSetsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshotSetsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshotSetsResponse + A response that contains a list of app screenshot set resources. + + Full documentation: + + */ public struct AppScreenshotSetsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppScreenshotSet diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshotUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshotUpdateRequest.swift index b1656d23d..b73ac3448 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshotUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshotUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshotUpdateRequest + The request body you use to update an App Screenshot. + + Full documentation: + + */ public struct AppScreenshotUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppScreenshotsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppScreenshotsResponse.swift index fdf514e33..54e67355a 100644 --- a/Sources/Bagbutik-Models/AppStore/AppScreenshotsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppScreenshotsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppScreenshotsResponse + A response that contains a list of App Screenshots resources. + + Full documentation: + + */ public struct AppScreenshotsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppScreenshot diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachment.swift b/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachment.swift index d1b90761e..249fe154e 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachment.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachment.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreReviewAttachment + The data structure that represent an App Store Review Attachments resource. + + Full documentation: + + */ public struct AppStoreReviewAttachment: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentCreateRequest.swift index 1a24b02b9..c071d360a 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreReviewAttachmentCreateRequest + The request body you use to create an App Store Review Attachment. + + Full documentation: + + */ public struct AppStoreReviewAttachmentCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentResponse.swift index 73386b4e4..7afaab69d 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreReviewAttachmentResponse + A response that contains a single App Store Review Attachments resource. + + Full documentation: + + */ public struct AppStoreReviewAttachmentResponse: Codable, Sendable { public let data: AppStoreReviewAttachment public var included: [AppStoreReviewDetail]? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentUpdateRequest.swift index dcc16479f..0a9a21c4f 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreReviewAttachmentUpdateRequest + The request body you use to update an App Store Review Attachment. + + Full documentation: + + */ public struct AppStoreReviewAttachmentUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentsResponse.swift index b95083598..40fb04822 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreReviewAttachmentsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreReviewAttachmentsResponse + A response that contains a list of App Store Review Attachment resources. + + Full documentation: + + */ public struct AppStoreReviewAttachmentsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppStoreReviewAttachment diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetail.swift b/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetail.swift index 9df26e784..7af811d32 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetail.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetail.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreReviewDetail + The data structure that represent an App Store Review Details resource. + + Full documentation: + + */ public struct AppStoreReviewDetail: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailCreateRequest.swift index d80b989b4..c7da10b67 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreReviewDetailCreateRequest + The request body you use to create an App Store Review Detail. + + Full documentation: + + */ public struct AppStoreReviewDetailCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailResponse.swift index a561d07eb..30a5a363f 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreReviewDetailResponse + A response that contains a single App Store Review Details resource. + + Full documentation: + + */ public struct AppStoreReviewDetailResponse: Codable, Sendable { public let data: AppStoreReviewDetail public var included: [Included]? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailUpdateRequest.swift index b60886e89..5e327e718 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreReviewDetailUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreReviewDetailUpdateRequest + The request body you use to update an App Store Review Detail. + + Full documentation: + + */ public struct AppStoreReviewDetailUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersion.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersion.swift index 1616c851d..837946534 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersion.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersion.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersion + The data structure that represent an App Store Versions resource. + + Full documentation: + + */ public struct AppStoreVersion: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionAppClipDefaultExperienceLinkageRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionAppClipDefaultExperienceLinkageRequest.swift index 838be5a16..88b020f3b 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionAppClipDefaultExperienceLinkageRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionAppClipDefaultExperienceLinkageRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionAppClipDefaultExperienceLinkageRequest + The request body you use to attach a default App Clip experience to an App Store version. + + Full documentation: + + */ public struct AppStoreVersionAppClipDefaultExperienceLinkageRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. @NullCodable public var data: Data? public init(data: Data? = nil) { diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionAppClipDefaultExperienceLinkageResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionAppClipDefaultExperienceLinkageResponse.swift index 5ab9b4311..935759cfa 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionAppClipDefaultExperienceLinkageResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionAppClipDefaultExperienceLinkageResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionAppClipDefaultExperienceLinkageResponse + A response that contains the ID of a single related Default App Clip Experiences resource. + + Full documentation: + + */ public struct AppStoreVersionAppClipDefaultExperienceLinkageResponse: Codable, Sendable { + /// The object types and IDs of the related resources. public let data: Data + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: Data, diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionBuildLinkageRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionBuildLinkageRequest.swift index 8c73a398b..503b964a6 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionBuildLinkageRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionBuildLinkageRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionBuildLinkageRequest + The request body you use to attach a build to an App Store version. + + Full documentation: + + */ public struct AppStoreVersionBuildLinkageRequest: Codable, Sendable, RequestBody { @NullCodable public var data: Data? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionBuildLinkageResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionBuildLinkageResponse.swift index a90324894..9e2360978 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionBuildLinkageResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionBuildLinkageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionBuildLinkageResponse + A response body that contains the ID of a single related resource. + + Full documentation: + + */ public struct AppStoreVersionBuildLinkageResponse: Codable, Sendable { public let data: Data public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionCreateRequest.swift index a509e9e6b..6d5c79bb2 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionCreateRequest + The request body you use to create an App Store Version. + + Full documentation: + + */ public struct AppStoreVersionCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalization.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalization.swift index ce56e4923..cb4ddc2d7 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalization.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalization.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionLocalization + The data structure that represent an App Store Version Localizations resource. + + Full documentation: + + */ public struct AppStoreVersionLocalization: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationCreateRequest.swift index 5a810ef33..c71b0ddfc 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionLocalizationCreateRequest + The request body you use to create an App Store Version Localization. + + Full documentation: + + */ public struct AppStoreVersionLocalizationCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationResponse.swift index e7e08c31b..db478e977 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionLocalizationResponse + A response that contains a single App Store Version Localizations resource. + + Full documentation: + + */ public struct AppStoreVersionLocalizationResponse: Codable, Sendable { public let data: AppStoreVersionLocalization public var included: [Included]? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationUpdateRequest.swift index ef72a0b7f..8052f626d 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionLocalizationUpdateRequest + The request body you use to update an App Store Version Localization + + Full documentation: + + */ public struct AppStoreVersionLocalizationUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationsResponse.swift index d3f7392c2..4aa35b738 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionLocalizationsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionLocalizationsResponse + A response that contains a list of App Store Version Localization resources. + + Full documentation: + + */ public struct AppStoreVersionLocalizationsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppStoreVersionLocalization diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedRelease.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedRelease.swift index 36e6598ed..c4cad109d 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedRelease.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedRelease.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionPhasedRelease + The data structure that represent an App Store Version Phased Releases resource. + + Full documentation: + + */ public struct AppStoreVersionPhasedRelease: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseCreateRequest.swift index cb74eb9e1..db2b86c78 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionPhasedReleaseCreateRequest + The request body you use to create an App Store Version Phased Release. + + Full documentation: + + */ public struct AppStoreVersionPhasedReleaseCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseResponse.swift index a4ee29b43..e5ba51ce2 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionPhasedReleaseResponse + A response that contains a single App Store Version Phased Releases resource. + + Full documentation: + + */ public struct AppStoreVersionPhasedReleaseResponse: Codable, Sendable { public let data: AppStoreVersionPhasedRelease public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseUpdateRequest.swift index d707004df..70098eb59 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionPhasedReleaseUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionPhasedReleaseUpdateRequest + The request body you use to update an App Store Version Phased Release. + + Full documentation: + + */ public struct AppStoreVersionPhasedReleaseUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequest.swift index 8ff20b128..b2ff362aa 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequest.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionReleaseRequest + The data structure that represents an App Store Version Release Request resource. + + Full documentation: + + */ public struct AppStoreVersionReleaseRequest: Codable, Sendable, Identifiable, RequestBody { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "appStoreVersionReleaseRequests" } public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequestCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequestCreateRequest.swift index 6b3d75660..b6f799b87 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequestCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequestCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionReleaseRequestCreateRequest + The request body you use to manually release an App Store approved version of your app. + + Full documentation: + + */ public struct AppStoreVersionReleaseRequestCreateRequest: Codable, Sendable, RequestBody { + /// The data element of the request body. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequestResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequestResponse.swift index 5d0e08ed9..062b748c3 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequestResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionReleaseRequestResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionReleaseRequestResponse + A response that contains a single App Store Version Release Request resource. + + Full documentation: + + */ public struct AppStoreVersionReleaseRequestResponse: Codable, Sendable { + /// The resource data. public let data: AppStoreVersionReleaseRequest + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: AppStoreVersionReleaseRequest, diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionResponse.swift index a97e354b8..f990bc27d 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionResponse + A response that contains a single App Store Versions resource. + + Full documentation: + + */ public struct AppStoreVersionResponse: Codable, Sendable { public let data: AppStoreVersion public var included: [Included]? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmission.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmission.swift index cc68802ef..d36bd74d4 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmission.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmission.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionSubmission + The data structure that represents an App Store Version Submissions resource. + + Full documentation: + + */ public struct AppStoreVersionSubmission: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmissionCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmissionCreateRequest.swift index 5c0299c17..5070ddab7 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmissionCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmissionCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionSubmissionCreateRequest + The request body you use to create an App Store Version Submission. + + Full documentation: + + */ public struct AppStoreVersionSubmissionCreateRequest: Codable, Sendable, RequestBody { + /// The data element of the request body. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmissionResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmissionResponse.swift index e276876e1..ef27671af 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmissionResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionSubmissionResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionSubmissionResponse + A response that contains a single App Store Version Submissions resource. + + Full documentation: + + */ public struct AppStoreVersionSubmissionResponse: Codable, Sendable { public let data: AppStoreVersionSubmission public var included: [AppStoreVersion]? diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionUpdateRequest.swift index c63c699fe..7b1d8ad47 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionUpdateRequest + The request body you use to update an App Store Version. + + Full documentation: + + */ public struct AppStoreVersionUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppStoreVersionsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppStoreVersionsResponse.swift index fa189f421..38115bbf5 100644 --- a/Sources/Bagbutik-Models/AppStore/AppStoreVersionsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppStoreVersionsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppStoreVersionsResponse + A response that contains a list of App Store Version resources. + + Full documentation: + + */ public struct AppStoreVersionsResponse: Codable, Sendable, PagedResponse { public typealias Data = AppStoreVersion diff --git a/Sources/Bagbutik-Models/AppStore/AppUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/AppUpdateRequest.swift index c9e2a7ef9..3844363e8 100644 --- a/Sources/Bagbutik-Models/AppStore/AppUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/AppUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppUpdateRequest + The request body you use to update an App Update. + + Full documentation: + + */ public struct AppUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/AppsResponse.swift b/Sources/Bagbutik-Models/AppStore/AppsResponse.swift index 4422eb0fa..f5bf1e469 100644 --- a/Sources/Bagbutik-Models/AppStore/AppsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/AppsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # AppsResponse + A response that contains a list of Apps resources. + + Full documentation: + + */ public struct AppsResponse: Codable, Sendable, PagedResponse { public typealias Data = App + /// The resource data. public let data: [App] public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [App], diff --git a/Sources/Bagbutik-Models/AppStore/BetaAppClipInvocationsResponse.swift b/Sources/Bagbutik-Models/AppStore/BetaAppClipInvocationsResponse.swift index 96bf1084f..02cb278c4 100644 --- a/Sources/Bagbutik-Models/AppStore/BetaAppClipInvocationsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/BetaAppClipInvocationsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BetaAppClipInvocationsResponse + A response that contains a list of Beta App Clip Invocations resources. + + Full documentation: + + */ public struct BetaAppClipInvocationsResponse: Codable, Sendable, PagedResponse { public typealias Data = BetaAppClipInvocation + /// The resource data. public let data: [BetaAppClipInvocation] + /// The requested relationship data. public var included: [BetaAppClipInvocationLocalization]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [BetaAppClipInvocation], diff --git a/Sources/Bagbutik-Models/AppStore/BetaBuildUsagesV1MetricResponse.swift b/Sources/Bagbutik-Models/AppStore/BetaBuildUsagesV1MetricResponse.swift index 61e0d5058..87f607123 100644 --- a/Sources/Bagbutik-Models/AppStore/BetaBuildUsagesV1MetricResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/BetaBuildUsagesV1MetricResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # BetaBuildUsagesV1MetricResponse + A response that contains one or more beta build metric resources. + + Full documentation: + + */ public struct BetaBuildUsagesV1MetricResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/AppStore/Build.swift b/Sources/Bagbutik-Models/AppStore/Build.swift index fa813dc87..79f0c51d2 100644 --- a/Sources/Bagbutik-Models/AppStore/Build.swift +++ b/Sources/Bagbutik-Models/AppStore/Build.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # Build + The data structure that represents a Builds resource. + + Full documentation: + + */ public struct Build: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "builds" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/BuildAppEncryptionDeclarationLinkageRequest.swift b/Sources/Bagbutik-Models/AppStore/BuildAppEncryptionDeclarationLinkageRequest.swift index d3df02773..78ff84d5e 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildAppEncryptionDeclarationLinkageRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildAppEncryptionDeclarationLinkageRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BuildAppEncryptionDeclarationLinkageRequest + The request body you use to attach an app encryption declaration to a build. + + Full documentation: + + */ public struct BuildAppEncryptionDeclarationLinkageRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. @NullCodable public var data: Data? public init(data: Data? = nil) { diff --git a/Sources/Bagbutik-Models/AppStore/BuildAppEncryptionDeclarationLinkageResponse.swift b/Sources/Bagbutik-Models/AppStore/BuildAppEncryptionDeclarationLinkageResponse.swift index b282f1cc9..7f6c3296b 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildAppEncryptionDeclarationLinkageResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildAppEncryptionDeclarationLinkageResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # BuildAppEncryptionDeclarationLinkageResponse + A response body that contains the ID of a single related resource. + + Full documentation: + + */ public struct BuildAppEncryptionDeclarationLinkageResponse: Codable, Sendable { + /// The object types and IDs of the related resources. public let data: Data + /// Navigational links including the self-link and links to the related data. public let links: DocumentLinks public init(data: Data, diff --git a/Sources/Bagbutik-Models/AppStore/BuildBetaGroupsLinkagesRequest.swift b/Sources/Bagbutik-Models/AppStore/BuildBetaGroupsLinkagesRequest.swift index ade1d6f65..6f88fa9d4 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildBetaGroupsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildBetaGroupsLinkagesRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BuildBetaGroupsLinkagesRequest + A request body you use to add or remove beta groups from a build. + + Full documentation: + + */ public struct BuildBetaGroupsLinkagesRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. public let data: [Data] public init(data: [Data]) { diff --git a/Sources/Bagbutik-Models/AppStore/BuildBundle.swift b/Sources/Bagbutik-Models/AppStore/BuildBundle.swift index a92a085e3..4125739ea 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildBundle.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildBundle.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BuildBundle + The data structure that represents Build Bundles resource. + + Full documentation: + + */ public struct BuildBundle: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Build Bundles resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "buildBundles" } + /// The attributes that describe the Build Bundles resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/BuildBundleFileSize.swift b/Sources/Bagbutik-Models/AppStore/BuildBundleFileSize.swift index a1718886b..b0c8feadf 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildBundleFileSize.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildBundleFileSize.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # BuildBundleFileSize + The data structure that represents a Build Bundle File Sizes resource. + + Full documentation: + + */ public struct BuildBundleFileSize: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Build Bundles File Sizes resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "buildBundleFileSizes" } + /// The attributes that describe the Build Bundle File Sizes resource. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/BuildBundleFileSizesResponse.swift b/Sources/Bagbutik-Models/AppStore/BuildBundleFileSizesResponse.swift index 113a3da21..06725caff 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildBundleFileSizesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildBundleFileSizesResponse.swift @@ -1,11 +1,21 @@ import Bagbutik_Core import Foundation +/** + # BuildBundleFileSizesResponse + A response that contains a list of Build Bundle File Sizes resources. + + Full documentation: + + */ public struct BuildBundleFileSizesResponse: Codable, Sendable, PagedResponse { public typealias Data = BuildBundleFileSize + /// The resource data. public let data: [BuildBundleFileSize] + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [BuildBundleFileSize], diff --git a/Sources/Bagbutik-Models/AppStore/BuildIcon.swift b/Sources/Bagbutik-Models/AppStore/BuildIcon.swift index 8b9075316..c40cc17ad 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildIcon.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildIcon.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # BuildIcon + The data structure that represents the Build Icons resource. + + Full documentation: + + */ public struct BuildIcon: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/BuildIconsResponse.swift b/Sources/Bagbutik-Models/AppStore/BuildIconsResponse.swift index bd8e306f3..a98824803 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildIconsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildIconsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # BuildIconsResponse + A response that contains a list of Build Icon resources. + + Full documentation: + + */ public struct BuildIconsResponse: Codable, Sendable, PagedResponse { public typealias Data = BuildIcon diff --git a/Sources/Bagbutik-Models/AppStore/BuildIndividualTestersLinkagesRequest.swift b/Sources/Bagbutik-Models/AppStore/BuildIndividualTestersLinkagesRequest.swift index 2621e605b..2b00ceef3 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildIndividualTestersLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildIndividualTestersLinkagesRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BuildIndividualTestersLinkagesRequest + A request body you use to add or remove a build from multiple beta groups. + + Full documentation: + + */ public struct BuildIndividualTestersLinkagesRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. public let data: [Data] public init(data: [Data]) { diff --git a/Sources/Bagbutik-Models/AppStore/BuildIndividualTestersLinkagesResponse.swift b/Sources/Bagbutik-Models/AppStore/BuildIndividualTestersLinkagesResponse.swift index a8322e362..7051d5486 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildIndividualTestersLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildIndividualTestersLinkagesResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # BuildIndividualTestersLinkagesResponse + A response body that contains a list of related resource IDs. + + Full documentation: + + */ public struct BuildIndividualTestersLinkagesResponse: Codable, Sendable, PagedResponse { + /// The object types and IDs of the related resources. public let data: [Data] + /// Navigational links including the self-link and links to the related data. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [Data], diff --git a/Sources/Bagbutik-Models/AppStore/BuildResponse.swift b/Sources/Bagbutik-Models/AppStore/BuildResponse.swift index 54c18afb9..85114820f 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # BuildResponse + A response that contains a single Builds resource. + + Full documentation: + + */ public struct BuildResponse: Codable, Sendable { + /// The resource data. public let data: Build public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: Build, diff --git a/Sources/Bagbutik-Models/AppStore/BuildUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/BuildUpdateRequest.swift index b8c2f6cb7..bba518331 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BuildUpdateRequest + The request body you use to update a Build. + + Full documentation: + + */ public struct BuildUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/BuildsResponse.swift b/Sources/Bagbutik-Models/AppStore/BuildsResponse.swift index 6cb35c00b..837ea66c8 100644 --- a/Sources/Bagbutik-Models/AppStore/BuildsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/BuildsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # BuildsResponse + A response that contains a list of Builds resources. + + Full documentation: + + */ public struct BuildsResponse: Codable, Sendable, PagedResponse { public typealias Data = Build + /// The resource data. public let data: [Build] public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [Build], diff --git a/Sources/Bagbutik-Models/AppStore/CustomerReview.swift b/Sources/Bagbutik-Models/AppStore/CustomerReview.swift index 92672a611..a50639390 100644 --- a/Sources/Bagbutik-Models/AppStore/CustomerReview.swift +++ b/Sources/Bagbutik-Models/AppStore/CustomerReview.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CustomerReview + The data structure that represents a Customer Reviews resource. + + Full documentation: + + */ public struct CustomerReview: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the `CustomerReviews` resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "customerReviews" } + /// The attributes of the customer’s review including its content. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/CustomerReviewResponse.swift b/Sources/Bagbutik-Models/AppStore/CustomerReviewResponse.swift index f88f5a1e9..d1793eeb9 100644 --- a/Sources/Bagbutik-Models/AppStore/CustomerReviewResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/CustomerReviewResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CustomerReviewResponse + A response that contains a single Customer Review resource. + + Full documentation: + + */ public struct CustomerReviewResponse: Codable, Sendable { + /// The data structure that represents a `CustomerReviews` resource. public let data: CustomerReview + /// The requested relationship data. public var included: [CustomerReviewResponseV1]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: CustomerReview, diff --git a/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1.swift b/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1.swift index 67211e549..d8ab3ada2 100644 --- a/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1.swift +++ b/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CustomerReviewResponseV1 + The data structure that represents the Customer Review Responses resource. + + Full documentation: + + */ public struct CustomerReviewResponseV1: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the `CustomerReviewResponses` resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "customerReviewResponses" } + /// The attributes of the response to the customer’s review, including its content. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1CreateRequest.swift b/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1CreateRequest.swift index b3f6b0f18..0488ae009 100644 --- a/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1CreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1CreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # CustomerReviewResponseV1CreateRequest + The request body to use to create a response to a customer review. + + Full documentation: + + */ public struct CustomerReviewResponseV1CreateRequest: Codable, Sendable, RequestBody { + /// The resource data for your customer review response. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1Response.swift b/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1Response.swift index 24d3d0ec6..c98e5b6ef 100644 --- a/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1Response.swift +++ b/Sources/Bagbutik-Models/AppStore/CustomerReviewResponseV1Response.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CustomerReviewResponseV1Response + A response that contains a single Customer Review Responses resource. + + Full documentation: + + */ public struct CustomerReviewResponseV1Response: Codable, Sendable { + /// The data structure that represents a `CustomerReviewResponses` resource. public let data: CustomerReviewResponseV1 + /// The requested relationship data. public var included: [CustomerReview]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: CustomerReviewResponseV1, diff --git a/Sources/Bagbutik-Models/AppStore/CustomerReviewsResponse.swift b/Sources/Bagbutik-Models/AppStore/CustomerReviewsResponse.swift index 64ebe926b..f2723fbec 100644 --- a/Sources/Bagbutik-Models/AppStore/CustomerReviewsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/CustomerReviewsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CustomerReviewsResponse + A response that contains a list of Customer Reviews resources. + + Full documentation: + + */ public struct CustomerReviewsResponse: Codable, Sendable, PagedResponse { public typealias Data = CustomerReview + /// A list of customer review resource data. public let data: [CustomerReview] + /// The requested relationship data. public var included: [CustomerReviewResponseV1]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [CustomerReview], diff --git a/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrder.swift b/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrder.swift index d318c6a28..762c9fc74 100644 --- a/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrder.swift +++ b/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrder.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # EndAppAvailabilityPreOrder + The data structure that represents the ending of an app preorder resource. + + Full documentation: + + */ public struct EndAppAvailabilityPreOrder: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrderCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrderCreateRequest.swift index 001ae5447..e7bd8d24e 100644 --- a/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrderCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrderCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # EndAppAvailabilityPreOrderCreateRequest + The request body you use to end an app’s preorder availability. + + Full documentation: + + */ public struct EndAppAvailabilityPreOrderCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrderResponse.swift b/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrderResponse.swift index 10cdbc03a..b3fb4ef77 100644 --- a/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrderResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/EndAppAvailabilityPreOrderResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # EndAppAvailabilityPreOrderResponse + A response that contains a single end app availability resource. + + Full documentation: + + */ public struct EndAppAvailabilityPreOrderResponse: Codable, Sendable { public let data: EndAppAvailabilityPreOrder public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreement.swift b/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreement.swift index 743ce50a6..113385134 100644 --- a/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreement.swift +++ b/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreement.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # EndUserLicenseAgreement + The data structure that represents the End User License Agreement resource. + + Full documentation: + + */ public struct EndUserLicenseAgreement: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementCreateRequest.swift index a193c2ce5..9ea557ba1 100644 --- a/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # EndUserLicenseAgreementCreateRequest + The request body you use to create an End User License Agreement. + + Full documentation: + + */ public struct EndUserLicenseAgreementCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementResponse.swift b/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementResponse.swift index a3ce30b5f..30fd0bc47 100644 --- a/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # EndUserLicenseAgreementResponse + A response that contains a single End User License Agreements resource. + + Full documentation: + + */ public struct EndUserLicenseAgreementResponse: Codable, Sendable { public let data: EndUserLicenseAgreement public var included: [Included]? diff --git a/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementUpdateRequest.swift index 27bedae83..066120036 100644 --- a/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/EndUserLicenseAgreementUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # EndUserLicenseAgreementUpdateRequest + The request body you use to update an End User License Agreement. + + Full documentation: + + */ public struct EndUserLicenseAgreementUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersion.swift b/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersion.swift index 5618810a0..208d7252b 100644 --- a/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersion.swift +++ b/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersion.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterEnabledVersion + The data structure that represents the Game Center Enabled Versions resource. + + Full documentation: + + */ public struct GameCenterEnabledVersion: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest.swift b/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest.swift index 2ba0002fb..f632af351 100644 --- a/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionCompatibleVersionsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterEnabledVersionCompatibleVersionsLinkagesRequest + A request body you use to add or remove compatible versions from a Game Center-enabled version. + + Full documentation: + + */ public struct GameCenterEnabledVersionCompatibleVersionsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionCompatibleVersionsLinkagesResponse.swift b/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionCompatibleVersionsLinkagesResponse.swift index f9987c4aa..85422ff39 100644 --- a/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionCompatibleVersionsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionCompatibleVersionsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterEnabledVersionCompatibleVersionsLinkagesResponse + A response body that contains a list of related resource IDs. + + Full documentation: + + */ public struct GameCenterEnabledVersionCompatibleVersionsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionsResponse.swift b/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionsResponse.swift index f36208aff..ada3a5172 100644 --- a/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionsResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/GameCenterEnabledVersionsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterEnabledVersionsResponse + A response that contains a list of Game Center Enabled Version resources. + + Full documentation: + + */ public struct GameCenterEnabledVersionsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterEnabledVersion diff --git a/Sources/Bagbutik-Models/AppStore/ImageAsset.swift b/Sources/Bagbutik-Models/AppStore/ImageAsset.swift index 1c0854471..84fb9440e 100644 --- a/Sources/Bagbutik-Models/AppStore/ImageAsset.swift +++ b/Sources/Bagbutik-Models/AppStore/ImageAsset.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # ImageAsset + An image asset, including its height, width, and template URL. + + Full documentation: + + */ public struct ImageAsset: Codable, Sendable { public var height: Int? public var templateUrl: String? diff --git a/Sources/Bagbutik-Models/AppStore/InAppPurchase.swift b/Sources/Bagbutik-Models/AppStore/InAppPurchase.swift index e37967782..829384594 100644 --- a/Sources/Bagbutik-Models/AppStore/InAppPurchase.swift +++ b/Sources/Bagbutik-Models/AppStore/InAppPurchase.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # InAppPurchase + The data structure that represents the In-App Purchases resource. + + Full documentation: + + */ public struct InAppPurchase: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/InAppPurchaseImage.swift b/Sources/Bagbutik-Models/AppStore/InAppPurchaseImage.swift index 56ffaadc0..a06413f13 100644 --- a/Sources/Bagbutik-Models/AppStore/InAppPurchaseImage.swift +++ b/Sources/Bagbutik-Models/AppStore/InAppPurchaseImage.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # InAppPurchaseImage + The data structure that represents a in-app purchase image resource. + + Full documentation: + + */ public struct InAppPurchaseImage: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "inAppPurchaseImages" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageCreateRequest.swift index bda2c11c3..c0a72bc11 100644 --- a/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # InAppPurchaseImageCreateRequest + The request body you use to create a in-app purchase purchase image reservation. + + Full documentation: + + */ public struct InAppPurchaseImageCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageResponse.swift b/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageResponse.swift index 0883ec438..0e04b0fc5 100644 --- a/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # InAppPurchaseImageResponse + A response that contains a single in-app purchase images resource. + + Full documentation: + + */ public struct InAppPurchaseImageResponse: Codable, Sendable { public let data: InAppPurchaseImage public var included: [InAppPurchaseV2]? diff --git a/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageUpdateRequest.swift index 30d10f84b..5db827a3b 100644 --- a/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/InAppPurchaseImageUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # InAppPurchaseImageUpdateRequest + The data structure that represents a in-app purchase image resource. + + Full documentation: + + */ public struct InAppPurchaseImageUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/InAppPurchaseImagesResponse.swift b/Sources/Bagbutik-Models/AppStore/InAppPurchaseImagesResponse.swift index e217b2bdb..ea24cc57a 100644 --- a/Sources/Bagbutik-Models/AppStore/InAppPurchaseImagesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/InAppPurchaseImagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # InAppPurchaseImagesResponse + A response that contains a list of in-app purchase image resources. + + Full documentation: + + */ public struct InAppPurchaseImagesResponse: Codable, Sendable, PagedResponse { public typealias Data = InAppPurchaseImage diff --git a/Sources/Bagbutik-Models/AppStore/InAppPurchaseResponse.swift b/Sources/Bagbutik-Models/AppStore/InAppPurchaseResponse.swift index 29a05f21b..405763dce 100644 --- a/Sources/Bagbutik-Models/AppStore/InAppPurchaseResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/InAppPurchaseResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # InAppPurchaseResponse + A response that contains a single In-App Purchases resource. + + Full documentation: + + */ public struct InAppPurchaseResponse: Codable, Sendable { public let data: InAppPurchase public var included: [App]? diff --git a/Sources/Bagbutik-Models/AppStore/InAppPurchasesResponse.swift b/Sources/Bagbutik-Models/AppStore/InAppPurchasesResponse.swift index bb58c5a00..c04d34188 100644 --- a/Sources/Bagbutik-Models/AppStore/InAppPurchasesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/InAppPurchasesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # InAppPurchasesResponse + A response that contains a list of In-App Purchases resources. + + Full documentation: + + */ public struct InAppPurchasesResponse: Codable, Sendable, PagedResponse { public typealias Data = InAppPurchase diff --git a/Sources/Bagbutik-Models/AppStore/IntegerRange.swift b/Sources/Bagbutik-Models/AppStore/IntegerRange.swift index ccb47a0c4..92ca46896 100644 --- a/Sources/Bagbutik-Models/AppStore/IntegerRange.swift +++ b/Sources/Bagbutik-Models/AppStore/IntegerRange.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # IntegerRange + Describe the upper and lower integer bound of the attribute. + + Full documentation: + + */ public struct IntegerRange: Codable, Sendable { public var maximum: Int? public var minimum: Int? diff --git a/Sources/Bagbutik-Models/AppStore/RoutingAppCoverage.swift b/Sources/Bagbutik-Models/AppStore/RoutingAppCoverage.swift index 74f5bf4c9..3e8d06475 100644 --- a/Sources/Bagbutik-Models/AppStore/RoutingAppCoverage.swift +++ b/Sources/Bagbutik-Models/AppStore/RoutingAppCoverage.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # RoutingAppCoverage + The data structure that represents the Routing App Coverages resource. + + Full documentation: + + */ public struct RoutingAppCoverage: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageCreateRequest.swift index 1b91037a9..9e6b5263f 100644 --- a/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # RoutingAppCoverageCreateRequest + The request body you use to create a Routing App Coverage. + + Full documentation: + + */ public struct RoutingAppCoverageCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageResponse.swift b/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageResponse.swift index 0fbd5c2e9..d20bf63ca 100644 --- a/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # RoutingAppCoverageResponse + A response that contains a single Routing App Coverages resource. + + Full documentation: + + */ public struct RoutingAppCoverageResponse: Codable, Sendable { public let data: RoutingAppCoverage public var included: [AppStoreVersion]? diff --git a/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageUpdateRequest.swift index 28502450d..5dbc21313 100644 --- a/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/RoutingAppCoverageUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # RoutingAppCoverageUpdateRequest + The request body you use to update a Routing App Coverage. + + Full documentation: + + */ public struct RoutingAppCoverageUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/SubscriptionImage.swift b/Sources/Bagbutik-Models/AppStore/SubscriptionImage.swift index dc5cab609..b2511ce1b 100644 --- a/Sources/Bagbutik-Models/AppStore/SubscriptionImage.swift +++ b/Sources/Bagbutik-Models/AppStore/SubscriptionImage.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # SubscriptionImage + The data structure that represents a subscription image resource. + + Full documentation: + + */ public struct SubscriptionImage: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "subscriptionImages" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/SubscriptionImageCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/SubscriptionImageCreateRequest.swift index 19449b5eb..8b5927770 100644 --- a/Sources/Bagbutik-Models/AppStore/SubscriptionImageCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/SubscriptionImageCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # SubscriptionImageCreateRequest + The request body you use to create a subscription purchase image reservation. + + Full documentation: + + */ public struct SubscriptionImageCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/SubscriptionImageResponse.swift b/Sources/Bagbutik-Models/AppStore/SubscriptionImageResponse.swift index f33cc21a1..b5d59245f 100644 --- a/Sources/Bagbutik-Models/AppStore/SubscriptionImageResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/SubscriptionImageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # SubscriptionImageResponse + A response that contains a single subscription images resource. + + Full documentation: + + */ public struct SubscriptionImageResponse: Codable, Sendable { public let data: SubscriptionImage public var included: [Subscription]? diff --git a/Sources/Bagbutik-Models/AppStore/SubscriptionImageUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/SubscriptionImageUpdateRequest.swift index ecd779535..237d1d666 100644 --- a/Sources/Bagbutik-Models/AppStore/SubscriptionImageUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/SubscriptionImageUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # SubscriptionImageUpdateRequest + The data structure that represents a subscription image update request resource. + + Full documentation: + + */ public struct SubscriptionImageUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/SubscriptionImagesResponse.swift b/Sources/Bagbutik-Models/AppStore/SubscriptionImagesResponse.swift index 679f884b5..6fe918681 100644 --- a/Sources/Bagbutik-Models/AppStore/SubscriptionImagesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/SubscriptionImagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # SubscriptionImagesResponse + A response that contains a list of subscription image resources. + + Full documentation: + + */ public struct SubscriptionImagesResponse: Codable, Sendable, PagedResponse { public typealias Data = SubscriptionImage diff --git a/Sources/Bagbutik-Models/AppStore/TerritoriesResponse.swift b/Sources/Bagbutik-Models/AppStore/TerritoriesResponse.swift index c31ba80ef..d23466275 100644 --- a/Sources/Bagbutik-Models/AppStore/TerritoriesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/TerritoriesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # TerritoriesResponse + A response that contains a list of Territory resources. + + Full documentation: + + */ public struct TerritoriesResponse: Codable, Sendable, PagedResponse { public typealias Data = Territory diff --git a/Sources/Bagbutik-Models/AppStore/Territory.swift b/Sources/Bagbutik-Models/AppStore/Territory.swift index 458abfba5..68b56c0ec 100644 --- a/Sources/Bagbutik-Models/AppStore/Territory.swift +++ b/Sources/Bagbutik-Models/AppStore/Territory.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # Territory + The data structure that represents a Territories resource. + + Full documentation: + + */ public struct Territory: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilitiesResponse.swift b/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilitiesResponse.swift index 6850c4f08..92a3efff2 100644 --- a/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilitiesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilitiesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # TerritoryAvailabilitiesResponse + A response that contains a list of territory availability resources. + + Full documentation: + + */ public struct TerritoryAvailabilitiesResponse: Codable, Sendable, PagedResponse { public typealias Data = TerritoryAvailability diff --git a/Sources/Bagbutik-Models/AppStore/TerritoryAvailability.swift b/Sources/Bagbutik-Models/AppStore/TerritoryAvailability.swift index 13c76fa39..4d188a25e 100644 --- a/Sources/Bagbutik-Models/AppStore/TerritoryAvailability.swift +++ b/Sources/Bagbutik-Models/AppStore/TerritoryAvailability.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # TerritoryAvailability + The data structure that represents a territory availability resource. + + Full documentation: + + */ public struct TerritoryAvailability: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityInlineCreate.swift b/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityInlineCreate.swift index 6ccff13d1..eb0dbad64 100644 --- a/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityInlineCreate.swift +++ b/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityInlineCreate.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # TerritoryAvailabilityInlineCreate + The request body you use to create a territory availability. + + Full documentation: + + */ public struct TerritoryAvailabilityInlineCreate: Codable, Sendable, Identifiable { public var id: String? public var type: String { "territoryAvailabilities" } diff --git a/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityResponse.swift b/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityResponse.swift index 162268699..eada54c5c 100644 --- a/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # TerritoryAvailabilityResponse + A response that contains a single territory availability resource. + + Full documentation: + + */ public struct TerritoryAvailabilityResponse: Codable, Sendable { public let data: TerritoryAvailability public var included: [Territory]? diff --git a/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityUpdateRequest.swift index d97aafd64..be95529a9 100644 --- a/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/TerritoryAvailabilityUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # TerritoryAvailabilityUpdateRequest + The request body you use to update a single territory availability resource. + + Full documentation: + + */ public struct TerritoryAvailabilityUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/TerritoryResponse.swift b/Sources/Bagbutik-Models/AppStore/TerritoryResponse.swift index bbb6c4ec2..2486cd92d 100644 --- a/Sources/Bagbutik-Models/AppStore/TerritoryResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/TerritoryResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # TerritoryResponse + A response that contains a single Territories resource. + + Full documentation: + + */ public struct TerritoryResponse: Codable, Sendable { public let data: Territory public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/AppStore/UploadOperation.swift b/Sources/Bagbutik-Models/AppStore/UploadOperation.swift index cbcf909ad..a29237b71 100644 --- a/Sources/Bagbutik-Models/AppStore/UploadOperation.swift +++ b/Sources/Bagbutik-Models/AppStore/UploadOperation.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # UploadOperation + Upload instructions for assets such as app previews and app screenshots. + + Full documentation: + + */ public struct UploadOperation: Codable, Sendable { public var length: Int? public var method: String? diff --git a/Sources/Bagbutik-Models/AppStore/WinBackOffer.swift b/Sources/Bagbutik-Models/AppStore/WinBackOffer.swift index f6a2f1466..f7ac9e670 100644 --- a/Sources/Bagbutik-Models/AppStore/WinBackOffer.swift +++ b/Sources/Bagbutik-Models/AppStore/WinBackOffer.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # WinBackOffer + The data structure that represents a win-back offer resource. + + Full documentation: + + */ public struct WinBackOffer: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "winBackOffers" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/WinBackOfferCreateRequest.swift b/Sources/Bagbutik-Models/AppStore/WinBackOfferCreateRequest.swift index ef18b7bee..87408f707 100644 --- a/Sources/Bagbutik-Models/AppStore/WinBackOfferCreateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/WinBackOfferCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # WinBackOfferCreateRequest + The request body you use to create a winback offer. + + Full documentation: + + */ public struct WinBackOfferCreateRequest: Codable, Sendable, RequestBody { public let data: Data public var included: [WinBackOfferPriceInlineCreate]? diff --git a/Sources/Bagbutik-Models/AppStore/WinBackOfferPrice.swift b/Sources/Bagbutik-Models/AppStore/WinBackOfferPrice.swift index f61db4d07..8ccd83f87 100644 --- a/Sources/Bagbutik-Models/AppStore/WinBackOfferPrice.swift +++ b/Sources/Bagbutik-Models/AppStore/WinBackOfferPrice.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # WinBackOfferPrice + The data structure that represents a winback offer price resource. + + Full documentation: + + */ public struct WinBackOfferPrice: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "winBackOfferPrices" } + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/AppStore/WinBackOfferPriceInlineCreate.swift b/Sources/Bagbutik-Models/AppStore/WinBackOfferPriceInlineCreate.swift index 90a6e4673..f4bc43654 100644 --- a/Sources/Bagbutik-Models/AppStore/WinBackOfferPriceInlineCreate.swift +++ b/Sources/Bagbutik-Models/AppStore/WinBackOfferPriceInlineCreate.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # WinBackOfferPriceInlineCreate + The data structure that represents a win-back offer price inline create resource. + + Full documentation: + + */ public struct WinBackOfferPriceInlineCreate: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public var id: String? + /// The resource type. public var type: String { "winBackOfferPrices" } public init(id: String? = nil) { diff --git a/Sources/Bagbutik-Models/AppStore/WinBackOfferPricesResponse.swift b/Sources/Bagbutik-Models/AppStore/WinBackOfferPricesResponse.swift index c4546b96f..c02ac75e2 100644 --- a/Sources/Bagbutik-Models/AppStore/WinBackOfferPricesResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/WinBackOfferPricesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # WinBackOfferPricesResponse + A response that contains a list of win-back offer price resources. + + Full documentation: + + */ public struct WinBackOfferPricesResponse: Codable, Sendable, PagedResponse { public typealias Data = WinBackOfferPrice diff --git a/Sources/Bagbutik-Models/AppStore/WinBackOfferResponse.swift b/Sources/Bagbutik-Models/AppStore/WinBackOfferResponse.swift index 61875933c..25891cc43 100644 --- a/Sources/Bagbutik-Models/AppStore/WinBackOfferResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/WinBackOfferResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # WinBackOfferResponse + A response that contains a single win-back offer resource. + + Full documentation: + + */ public struct WinBackOfferResponse: Codable, Sendable { public let data: WinBackOffer public var included: [WinBackOfferPrice]? diff --git a/Sources/Bagbutik-Models/AppStore/WinBackOfferUpdateRequest.swift b/Sources/Bagbutik-Models/AppStore/WinBackOfferUpdateRequest.swift index 71779d36b..fb5cb10e1 100644 --- a/Sources/Bagbutik-Models/AppStore/WinBackOfferUpdateRequest.swift +++ b/Sources/Bagbutik-Models/AppStore/WinBackOfferUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # WinBackOfferUpdateRequest + The request body you use to update a win-back offer. + + Full documentation: + + */ public struct WinBackOfferUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/AppStore/WinBackOffersResponse.swift b/Sources/Bagbutik-Models/AppStore/WinBackOffersResponse.swift index fe105c3b5..8e9ef7244 100644 --- a/Sources/Bagbutik-Models/AppStore/WinBackOffersResponse.swift +++ b/Sources/Bagbutik-Models/AppStore/WinBackOffersResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # WinBackOffersResponse + A response that contains a list of win-back offer resources. + + Full documentation: + + */ public struct WinBackOffersResponse: Codable, Sendable, PagedResponse { public typealias Data = WinBackOffer diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievement.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievement.swift index 1080427c8..6710e0a4a 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievement.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievement.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievement + The data structure that represents a Game Center achievement resource. + + Full documentation: + + */ public struct GameCenterAchievement: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementCreateRequest.swift index 2e3fa37d5..05704d214 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementCreateRequest + A request body you use to create a Game Center achievement. + + Full documentation: + + */ public struct GameCenterAchievementCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementGroupAchievementLinkageRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementGroupAchievementLinkageRequest.swift index 25acba8b4..e43d47fbb 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementGroupAchievementLinkageRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementGroupAchievementLinkageRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementGroupAchievementLinkageRequest + The request body you use to attach an achievement to an achievement group. + + Full documentation: + + */ public struct GameCenterAchievementGroupAchievementLinkageRequest: Codable, Sendable, RequestBody { @NullCodable public var data: Data? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementGroupAchievementLinkageResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementGroupAchievementLinkageResponse.swift index 91b7b01b3..4ffcf542c 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementGroupAchievementLinkageResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementGroupAchievementLinkageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementGroupAchievementLinkageResponse + A response body that contains the ID of a single related resource. + + Full documentation: + + */ public struct GameCenterAchievementGroupAchievementLinkageResponse: Codable, Sendable { public let data: Data public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImage.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImage.swift index d84024486..2ea731d4c 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImage.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImage.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementImage + The data structure that represent an achievements image resource. + + Full documentation: + + */ public struct GameCenterAchievementImage: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageCreateRequest.swift index cc3a724df..e790eb072 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementImageCreateRequest + The request body you use to create an achievement image. + + Full documentation: + + */ public struct GameCenterAchievementImageCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageResponse.swift index 3fb019678..ea497a4f7 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementImageResponse + A response that contains a single achievement image resource. + + Full documentation: + + */ public struct GameCenterAchievementImageResponse: Codable, Sendable { public let data: GameCenterAchievementImage public var included: [GameCenterAchievementLocalization]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageUpdateRequest.swift index 603fd75e5..fb943be69 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementImageUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementImageUpdateRequest + The request body you use to update an achievement image. + + Full documentation: + + */ public struct GameCenterAchievementImageUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementRelease.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementRelease.swift index 75866a15e..21486b4eb 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementRelease.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementRelease.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementRelease + The data structure that represent an achievements release resource. + + Full documentation: + + */ public struct GameCenterAchievementRelease: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleaseCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleaseCreateRequest.swift index 22378d6fa..c52d182bc 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleaseCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleaseCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementReleaseCreateRequest + The request body you use to create an achievement release. + + Full documentation: + + */ public struct GameCenterAchievementReleaseCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleaseResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleaseResponse.swift index ba9bb268d..5a70a5e97 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleaseResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleaseResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementReleaseResponse + A response that contains a single achievement release resource. + + Full documentation: + + */ public struct GameCenterAchievementReleaseResponse: Codable, Sendable { public let data: GameCenterAchievementRelease public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleasesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleasesResponse.swift index 0f01f1c19..b0322af45 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleasesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementReleasesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementReleasesResponse + A response that contains a list of achievement release resources. + + Full documentation: + + */ public struct GameCenterAchievementReleasesResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterAchievementRelease diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementResponse.swift index af0a19f5a..0a23fac03 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementResponse + A response that contains a single Game Center achievement resource. + + Full documentation: + + */ public struct GameCenterAchievementResponse: Codable, Sendable { public let data: GameCenterAchievement public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementUpdateRequest.swift index f88f5259a..b6fe50dc9 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementUpdateRequest + The request body you use to update a Game Center achievement. + + Full documentation: + + */ public struct GameCenterAchievementUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementsResponse.swift index a5cd7d352..8dfdc8557 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAchievementsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAchievementsResponse + A response that contains a list of Game Center achievement resources. + + Full documentation: + + */ public struct GameCenterAchievementsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterAchievement diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersion.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersion.swift index cc50170bc..40411868a 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersion.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersion.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAppVersion + The data structure that represents a Game Center app version resource. + + Full documentation: + + */ public struct GameCenterAppVersion: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCompatibilityVersionsLinkagesRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCompatibilityVersionsLinkagesRequest.swift index 0a333a335..3528c8fcd 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCompatibilityVersionsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCompatibilityVersionsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAppVersionCompatibilityVersionsLinkagesRequest + The request body you use to create a relationship between an app version and a compatibility version. + + Full documentation: + + */ public struct GameCenterAppVersionCompatibilityVersionsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCompatibilityVersionsLinkagesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCompatibilityVersionsLinkagesResponse.swift index 22ca46421..29b537e44 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCompatibilityVersionsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCompatibilityVersionsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAppVersionCompatibilityVersionsLinkagesResponse + A response that confirms a relationship between an app version and a compatilibty version. + + Full documentation: + + */ public struct GameCenterAppVersionCompatibilityVersionsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCreateRequest.swift index ee1d404a2..521a48bdb 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAppVersionCreateRequest + The request body you use to create an app version. + + Full documentation: + + */ public struct GameCenterAppVersionCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionResponse.swift index ed511ae27..56eec5e48 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAppVersionResponse + A response that contains a single app version resource. + + Full documentation: + + */ public struct GameCenterAppVersionResponse: Codable, Sendable { public let data: GameCenterAppVersion public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionUpdateRequest.swift index 3a7f4da5c..bd8fc174b 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAppVersionUpdateRequest + The request body you use to update an app version. + + Full documentation: + + */ public struct GameCenterAppVersionUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionsResponse.swift index ad13323b6..c017e63e2 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterAppVersionsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterAppVersionsResponse + A response that contains a list of app version resources. + + Full documentation: + + */ public struct GameCenterAppVersionsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterAppVersion diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetail.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetail.swift index cf07d65cf..3627c5970 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetail.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetail.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetail + The data structure that represents a Game Center detail resource. + + Full documentation: + + */ public struct GameCenterDetail: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailCreateRequest.swift index f1b6ef144..dc7a436f2 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetailCreateRequest + The request body you use to create a Game Center detail. + + Full documentation: + + */ public struct GameCenterDetailCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterAchievementsLinkagesRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterAchievementsLinkagesRequest.swift index 69db91c34..750b642f8 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterAchievementsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterAchievementsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetailGameCenterAchievementsLinkagesRequest + The request body you use to create a relationship between a Game Center detail and an achievement. + + Full documentation: + + */ public struct GameCenterDetailGameCenterAchievementsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterAchievementsLinkagesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterAchievementsLinkagesResponse.swift index 55c9a4818..7d626209b 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterAchievementsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterAchievementsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetailGameCenterAchievementsLinkagesResponse + A response that confirms a relationship between a Game Center detail and an achievement. + + Full documentation: + + */ public struct GameCenterDetailGameCenterAchievementsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardSetsLinkagesRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardSetsLinkagesRequest.swift index 723eb2bd2..69455cb2e 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardSetsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardSetsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetailGameCenterLeaderboardSetsLinkagesRequest + The request body you use to create a relationship between a Game Center detail and a leaderboard set. + + Full documentation: + + */ public struct GameCenterDetailGameCenterLeaderboardSetsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardSetsLinkagesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardSetsLinkagesResponse.swift index 616343501..27f44e5e0 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardSetsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardSetsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetailGameCenterLeaderboardSetsLinkagesResponse + A response that confirms a relationship between a Game Center detail and leaderboard set. + + Full documentation: + + */ public struct GameCenterDetailGameCenterLeaderboardSetsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardsLinkagesRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardsLinkagesRequest.swift index 1d10adb2b..1b528aaf2 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetailGameCenterLeaderboardsLinkagesRequest + The request body you use to create a relationship between a Game Center detail and a leaderboard. + + Full documentation: + + */ public struct GameCenterDetailGameCenterLeaderboardsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardsLinkagesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardsLinkagesResponse.swift index 57752b6c8..310da7bc4 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailGameCenterLeaderboardsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetailGameCenterLeaderboardsLinkagesResponse + A response that confirms a relationship between a Game Center detail and a leaderboard. + + Full documentation: + + */ public struct GameCenterDetailGameCenterLeaderboardsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailResponse.swift index db2fe0dd6..fcc79fb65 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetailResponse + A response that contains a single Game Center detail resource. + + Full documentation: + + */ public struct GameCenterDetailResponse: Codable, Sendable { public let data: GameCenterDetail public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailUpdateRequest.swift index 97b2a1b7d..013feaf2d 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetailUpdateRequest + The request body you use to update a Game Center detail. + + Full documentation: + + */ public struct GameCenterDetailUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailsResponse.swift index 0b3c0bc0b..d969855e4 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterDetailsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterDetailsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterDetailsResponse + A response that contains a list of Game Center detail resources. + + Full documentation: + + */ public struct GameCenterDetailsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterDetail diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroup.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroup.swift index 31e8a2b77..b88fe1506 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroup.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroup.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroup + The data structure that represents a group resource. + + Full documentation: + + */ public struct GameCenterGroup: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupCreateRequest.swift index 906ef081c..862856a5c 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroupCreateRequest + The request body you use to create a group. + + Full documentation: + + */ public struct GameCenterGroupCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterAchievementsLinkagesRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterAchievementsLinkagesRequest.swift index 13a6877a0..2ee875c85 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterAchievementsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterAchievementsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroupGameCenterAchievementsLinkagesRequest + The request body you use to create a relationship between a group and an achievement. + + Full documentation: + + */ public struct GameCenterGroupGameCenterAchievementsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterAchievementsLinkagesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterAchievementsLinkagesResponse.swift index 869668f04..a67502756 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterAchievementsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterAchievementsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroupGameCenterAchievementsLinkagesResponse + A response that confirms a relationship between a group and an achievement. + + Full documentation: + + */ public struct GameCenterGroupGameCenterAchievementsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardSetsLinkagesRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardSetsLinkagesRequest.swift index aa477bacb..c779cf7bf 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardSetsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardSetsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroupGameCenterLeaderboardSetsLinkagesRequest + The request body you use to create a relationship between a group and a leaderboard set. + + Full documentation: + + */ public struct GameCenterGroupGameCenterLeaderboardSetsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardSetsLinkagesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardSetsLinkagesResponse.swift index 81d435240..bdcb8c315 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardSetsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardSetsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroupGameCenterLeaderboardSetsLinkagesResponse + A response that confirms a relationship between a group and leaderboard set. + + Full documentation: + + */ public struct GameCenterGroupGameCenterLeaderboardSetsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardsLinkagesRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardsLinkagesRequest.swift index d070bd03c..b80547e5a 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroupGameCenterLeaderboardsLinkagesRequest + The request body you use to create a relationship between a group and a leaderboard. + + Full documentation: + + */ public struct GameCenterGroupGameCenterLeaderboardsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardsLinkagesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardsLinkagesResponse.swift index 141a1cd65..565392e8f 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupGameCenterLeaderboardsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroupGameCenterLeaderboardsLinkagesResponse + A response that confirms a relationship between a group and a leaderboard. + + Full documentation: + + */ public struct GameCenterGroupGameCenterLeaderboardsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupResponse.swift index f00f34919..b7eac69bc 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroupResponse + A response that contains a single group resource. + + Full documentation: + + */ public struct GameCenterGroupResponse: Codable, Sendable { public let data: GameCenterGroup public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupUpdateRequest.swift index 0e0848d05..62e09cc1e 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroupUpdateRequest + The request body you use to update a group. + + Full documentation: + + */ public struct GameCenterGroupUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupsResponse.swift index 5dc9642b1..29ff4bf3e 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterGroupsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterGroupsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterGroupsResponse + A response that contains one or more groups. + + Full documentation: + + */ public struct GameCenterGroupsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterGroup diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboard.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboard.swift index 165367d6a..841291e5d 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboard.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboard.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboard + The data structure that represent a leaderboard resource. + + Full documentation: + + */ public struct GameCenterLeaderboard: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardCreateRequest.swift index 13ad5c8b8..1fda57053 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardCreateRequest + The request body you use to create a leaderboard. + + Full documentation: + + */ public struct GameCenterLeaderboardCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmission.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmission.swift index 34c189b38..ff0383c20 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmission.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmission.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardEntrySubmission + The data structure that represent an Game Center leaderboard entry submission resource. + + Full documentation: + + */ public struct GameCenterLeaderboardEntrySubmission: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmissionCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmissionCreateRequest.swift index 1602487c3..0dae179ba 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmissionCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmissionCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardEntrySubmissionCreateRequest + The request body you use to create an Game Center leaderboard entry submssion. + + Full documentation: + + */ public struct GameCenterLeaderboardEntrySubmissionCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmissionResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmissionResponse.swift index 68851867f..a825690fa 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmissionResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardEntrySubmissionResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardEntrySubmissionResponse + A response that contains a Game Center leaderboard entry submission. + + Full documentation: + + */ public struct GameCenterLeaderboardEntrySubmissionResponse: Codable, Sendable { public let data: GameCenterLeaderboardEntrySubmission public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardGroupLeaderboardLinkageRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardGroupLeaderboardLinkageRequest.swift index a558c9e4a..94d9936de 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardGroupLeaderboardLinkageRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardGroupLeaderboardLinkageRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardGroupLeaderboardLinkageRequest + The request body you use to attach an individual leaderbaord to a group leaderboard. + + Full documentation: + + */ public struct GameCenterLeaderboardGroupLeaderboardLinkageRequest: Codable, Sendable, RequestBody { @NullCodable public var data: Data? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardGroupLeaderboardLinkageResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardGroupLeaderboardLinkageResponse.swift index d09cc5c1d..501e8ca7d 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardGroupLeaderboardLinkageResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardGroupLeaderboardLinkageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardGroupLeaderboardLinkageResponse + A response confriming a relationship between a leaderboard and group leaderboard. + + Full documentation: + + */ public struct GameCenterLeaderboardGroupLeaderboardLinkageResponse: Codable, Sendable { public let data: Data public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImage.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImage.swift index 8b58d1385..fbeaf9946 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImage.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImage.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardImage + The data structure that represent a leaderboard image resource. + + Full documentation: + + */ public struct GameCenterLeaderboardImage: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageCreateRequest.swift index da56bd0f1..13e3ea9e3 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardImageCreateRequest + The request body you use to create a leaderboard image. + + Full documentation: + + */ public struct GameCenterLeaderboardImageCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageResponse.swift index d4e42099d..5ce5b26c9 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardImageResponse + A response that contains a single leaderboard image resource. + + Full documentation: + + */ public struct GameCenterLeaderboardImageResponse: Codable, Sendable { public let data: GameCenterLeaderboardImage public var included: [GameCenterLeaderboardLocalization]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageUpdateRequest.swift index 181d5ef44..2e4c34bce 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardImageUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardImageUpdateRequest + The request body you use to update a leaderboard image. + + Full documentation: + + */ public struct GameCenterLeaderboardImageUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalization.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalization.swift index f560d7888..e6f18373c 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalization.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalization.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardLocalization + The data structure that represent a leaderboard localization. + + Full documentation: + + */ public struct GameCenterLeaderboardLocalization: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationCreateRequest.swift index 002d5e928..f6d68f97d 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardLocalizationCreateRequest + The request body you use to create a leaderboard localization. + + Full documentation: + + */ public struct GameCenterLeaderboardLocalizationCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationResponse.swift index 34ed584c2..906178569 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardLocalizationResponse + A response that contains a single leaderboard localization resource. + + Full documentation: + + */ public struct GameCenterLeaderboardLocalizationResponse: Codable, Sendable { public let data: GameCenterLeaderboardLocalization public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationUpdateRequest.swift index eac10c1b6..b76c4c480 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardLocalizationUpdateRequest + The request body you use to update a leaderboard localization. + + Full documentation: + + */ public struct GameCenterLeaderboardLocalizationUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationsResponse.swift index 75636ea1b..c3be02a08 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardLocalizationsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardLocalizationsResponse + A response that contains multiple leaderboard localizations resources. + + Full documentation: + + */ public struct GameCenterLeaderboardLocalizationsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterLeaderboardLocalization diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardRelease.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardRelease.swift index e9f593c6c..d6d5da3c3 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardRelease.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardRelease.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardRelease + The data structure that represents a leaderboard release. + + Full documentation: + + */ public struct GameCenterLeaderboardRelease: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleaseCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleaseCreateRequest.swift index f29280289..bd413486e 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleaseCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleaseCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardReleaseCreateRequest + The request body you use to create a leaderboard release. + + Full documentation: + + */ public struct GameCenterLeaderboardReleaseCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleaseResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleaseResponse.swift index 03d8b87d2..6ebb1c081 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleaseResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleaseResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardReleaseResponse + A response that contains a single leaderboard release resource. + + Full documentation: + + */ public struct GameCenterLeaderboardReleaseResponse: Codable, Sendable { public let data: GameCenterLeaderboardRelease public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleasesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleasesResponse.swift index 3fc120b31..3c8531800 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleasesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardReleasesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardReleasesResponse + A response that contains multiple leaderboard release resource. + + Full documentation: + + */ public struct GameCenterLeaderboardReleasesResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterLeaderboardRelease diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardResponse.swift index 786791fe7..7e823f826 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardResponse + A response that contains a single leaderboard image resource. + + Full documentation: + + */ public struct GameCenterLeaderboardResponse: Codable, Sendable { public let data: GameCenterLeaderboard public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSet.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSet.swift index f0f738767..d1032a1ad 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSet.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSet.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSet + The data structure that represent a leaderboard set resource. + + Full documentation: + + */ public struct GameCenterLeaderboardSet: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetCreateRequest.swift index 118038884..2ae1e987f 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetCreateRequest + The request body you use to create a leaderboard set. + + Full documentation: + + */ public struct GameCenterLeaderboardSetCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest.swift index 15578fe4e..4d744ae61 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest + The request body you use to create a relationship between a leaderboard set and a leaderboard. + + Full documentation: + + */ public struct GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesRequest: Codable, Sendable, RequestBody { public let data: [Data] diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesResponse.swift index f47eb6a71..85d4f7954 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesResponse + A response that confirms a relationship between a leaderboard set and a leaderboard. + + Full documentation: + + */ public struct GameCenterLeaderboardSetGameCenterLeaderboardsLinkagesResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGroupLeaderboardSetLinkageRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGroupLeaderboardSetLinkageRequest.swift index a876a38b1..fe902bbc5 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGroupLeaderboardSetLinkageRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGroupLeaderboardSetLinkageRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetGroupLeaderboardSetLinkageRequest + The request body you use to create a relationship between a leaderboard set and a group leaderboard set. + + Full documentation: + + */ public struct GameCenterLeaderboardSetGroupLeaderboardSetLinkageRequest: Codable, Sendable, RequestBody { @NullCodable public var data: Data? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGroupLeaderboardSetLinkageResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGroupLeaderboardSetLinkageResponse.swift index b8a84ea88..e85d1c2ef 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGroupLeaderboardSetLinkageResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetGroupLeaderboardSetLinkageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetGroupLeaderboardSetLinkageResponse + A response that confirms a relationship between a leaderboard set and a group leaderboard set. + + Full documentation: + + */ public struct GameCenterLeaderboardSetGroupLeaderboardSetLinkageResponse: Codable, Sendable { public let data: Data public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImage.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImage.swift index 6ab582685..30396a6e2 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImage.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImage.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetImage + The data structure that represent a leaderboard set image resource. + + Full documentation: + + */ public struct GameCenterLeaderboardSetImage: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageCreateRequest.swift index cc04d5edc..a6d339c53 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetImageCreateRequest + The request body you use to create a leaderboard set image. + + Full documentation: + + */ public struct GameCenterLeaderboardSetImageCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageResponse.swift index 6889dbbb0..781d3e397 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetImageResponse + A response that contains a single leaderboard set image resource. + + Full documentation: + + */ public struct GameCenterLeaderboardSetImageResponse: Codable, Sendable { public let data: GameCenterLeaderboardSetImage public var included: [GameCenterLeaderboardSetLocalization]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageUpdateRequest.swift index eef391e63..21ef542a1 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetImageUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetImageUpdateRequest + The request body you use to update a leaderboard set image. + + Full documentation: + + */ public struct GameCenterLeaderboardSetImageUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalization.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalization.swift index 08883671e..169a2a317 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalization.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalization.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetLocalization + The data structure that represent a leaderboard set localization. + + Full documentation: + + */ public struct GameCenterLeaderboardSetLocalization: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationCreateRequest.swift index 53c9d945e..4fe2e32b6 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetLocalizationCreateRequest + The request body you use to create a leaderboard set localization. + + Full documentation: + + */ public struct GameCenterLeaderboardSetLocalizationCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationResponse.swift index 4cdf52dd5..fb1ea0215 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetLocalizationResponse + A response that contains a single leaderboard set localization resource. + + Full documentation: + + */ public struct GameCenterLeaderboardSetLocalizationResponse: Codable, Sendable { public let data: GameCenterLeaderboardSetLocalization public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationUpdateRequest.swift index be6851978..078335120 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetLocalizationUpdateRequest + The request body you use to update a leaderboard localization. + + Full documentation: + + */ public struct GameCenterLeaderboardSetLocalizationUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationsResponse.swift index c6064267a..17306212e 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetLocalizationsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetLocalizationsResponse + A response that contains multiple leaderboard localizations resources. + + Full documentation: + + */ public struct GameCenterLeaderboardSetLocalizationsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterLeaderboardSetLocalization diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalization.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalization.swift index 1fcfac610..606fc14a6 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalization.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalization.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetMemberLocalization + The data structure that represent a leaderboard set member localization. + + Full documentation: + + */ public struct GameCenterLeaderboardSetMemberLocalization: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationCreateRequest.swift index 975e1ab92..2de43a855 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetMemberLocalizationCreateRequest + The request body you use to create a leaderboard set localization. + + Full documentation: + + */ public struct GameCenterLeaderboardSetMemberLocalizationCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationResponse.swift index 4e34ebecf..5e36fa745 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetMemberLocalizationResponse + A response that contains a single leaderboard set localization resource. + + Full documentation: + + */ public struct GameCenterLeaderboardSetMemberLocalizationResponse: Codable, Sendable { public let data: GameCenterLeaderboardSetMemberLocalization public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationUpdateRequest.swift index fd42adeb9..890d1ae13 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetMemberLocalizationUpdateRequest + The request body you use to update a leaderboard localization. + + Full documentation: + + */ public struct GameCenterLeaderboardSetMemberLocalizationUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationsResponse.swift index 3b48bb2ee..f92c80320 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetMemberLocalizationsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetMemberLocalizationsResponse + A response that contains multiple leaderboard localizations resources. + + Full documentation: + + */ public struct GameCenterLeaderboardSetMemberLocalizationsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterLeaderboardSetMemberLocalization diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetRelease.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetRelease.swift index db158c1ac..50e388f10 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetRelease.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetRelease.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetRelease + The data structure that represent a leaderboard set release. + + Full documentation: + + */ public struct GameCenterLeaderboardSetRelease: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleaseCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleaseCreateRequest.swift index c14c11a7d..f66cd63f2 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleaseCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleaseCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetReleaseCreateRequest + The request body you use to create a leaderboard set release. + + Full documentation: + + */ public struct GameCenterLeaderboardSetReleaseCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleaseResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleaseResponse.swift index 89577f387..df3bfdace 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleaseResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleaseResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetReleaseResponse + A response that contains a single leaderboard set release resource. + + Full documentation: + + */ public struct GameCenterLeaderboardSetReleaseResponse: Codable, Sendable { public let data: GameCenterLeaderboardSetRelease public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleasesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleasesResponse.swift index 92d8d7272..a0e213ee8 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleasesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetReleasesResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetReleasesResponse + A response that contains multiple leaderboard set release resource. + + Full documentation: + + */ public struct GameCenterLeaderboardSetReleasesResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterLeaderboardSetRelease diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetResponse.swift index c85efe566..8934fe936 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetResponse + A response that contains a single leaderboard set resource. + + Full documentation: + + */ public struct GameCenterLeaderboardSetResponse: Codable, Sendable { public let data: GameCenterLeaderboardSet public var included: [Included]? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetUpdateRequest.swift index 2ed8d0894..90992f161 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetUpdateRequest + The request body you use to update a leaderboard set. + + Full documentation: + + */ public struct GameCenterLeaderboardSetUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetsResponse.swift index 1ee8c9d1a..321ca3f2b 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardSetsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardSetsResponse + A response that contains multiple leaderboard set resources. + + Full documentation: + + */ public struct GameCenterLeaderboardSetsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterLeaderboardSet diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardUpdateRequest.swift index da2b10d73..ab9e03911 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardUpdateRequest + The request body you use to update a leaderboard. + + Full documentation: + + */ public struct GameCenterLeaderboardUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardsResponse.swift index 9bba0b0c6..2affd2c0e 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterLeaderboardsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterLeaderboardsResponse + A response that contains multiple leaderboard resources. + + Full documentation: + + */ public struct GameCenterLeaderboardsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterLeaderboard diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingAppRequestsV1MetricResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingAppRequestsV1MetricResponse.swift index 0d9cf1a7d..fb6f416d1 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingAppRequestsV1MetricResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingAppRequestsV1MetricResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingAppRequestsV1MetricResponse + The response body for fetching a match request. + + Full documentation: + + */ public struct GameCenterMatchmakingAppRequestsV1MetricResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingBooleanRuleResultsV1MetricResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingBooleanRuleResultsV1MetricResponse.swift index 944fdd780..7a137bd28 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingBooleanRuleResultsV1MetricResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingBooleanRuleResultsV1MetricResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingBooleanRuleResultsV1MetricResponse + The response body for fetching the results of applying Boolean rules. + + Full documentation: + + */ public struct GameCenterMatchmakingBooleanRuleResultsV1MetricResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingNumberRuleResultsV1MetricResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingNumberRuleResultsV1MetricResponse.swift index 22cd2855a..a097c222c 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingNumberRuleResultsV1MetricResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingNumberRuleResultsV1MetricResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingNumberRuleResultsV1MetricResponse + The response body for fetching the results of applying numeric rules. + + Full documentation: + + */ public struct GameCenterMatchmakingNumberRuleResultsV1MetricResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueue.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueue.swift index 62e7842b4..073bb247a 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueue.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueue.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingQueue + The data structure that represents a queue. + + Full documentation: + + */ public struct GameCenterMatchmakingQueue: Codable, Sendable, Identifiable { + /// The unique identifier for the rule. public let id: String + /// The link representations of the object. public var links: ResourceLinks? + /// The type of resource. public var type: String { "gameCenterMatchmakingQueues" } + /// The attributes of the queue. public var attributes: Attributes? + /// The relationships of the queue. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueCreateRequest.swift index e467a6833..059297715 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingQueueCreateRequest + The request body you use to create a queue. + + Full documentation: + + */ public struct GameCenterMatchmakingQueueCreateRequest: Codable, Sendable, RequestBody { + /// The data structure of the request body. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueRequestsV1MetricResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueRequestsV1MetricResponse.swift index 6a9697447..ef9498ada 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueRequestsV1MetricResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueRequestsV1MetricResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingQueueRequestsV1MetricResponse + The response body for match requests in a queue. + + Full documentation: + + */ public struct GameCenterMatchmakingQueueRequestsV1MetricResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueResponse.swift index 5b1bbb0b4..4658502d5 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingQueueResponse + The response body for endpoints that create, modify, or get a single queue. + + Full documentation: + + */ public struct GameCenterMatchmakingQueueResponse: Codable, Sendable { + /// The queue that you create, modify, or get. public let data: GameCenterMatchmakingQueue + /// The rule sets included in the response. public var included: [GameCenterMatchmakingRuleSet]? + /// The link representations of the response. public let links: DocumentLinks public init(data: GameCenterMatchmakingQueue, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueSizesV1MetricResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueSizesV1MetricResponse.swift index beed440d0..2be7a74e3 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueSizesV1MetricResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueSizesV1MetricResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingQueueSizesV1MetricResponse + The response body for fetching the queue sizes. + + Full documentation: + + */ public struct GameCenterMatchmakingQueueSizesV1MetricResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueUpdateRequest.swift index 971298152..0644b3289 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueueUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingQueueUpdateRequest + The request body you use to modify a queue. + + Full documentation: + + */ public struct GameCenterMatchmakingQueueUpdateRequest: Codable, Sendable, RequestBody { + /// The data structure of the request body. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueuesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueuesResponse.swift index c848f5549..25bfae097 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueuesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingQueuesResponse.swift @@ -1,11 +1,21 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingQueuesResponse + The response body for endpoints that get multiple queues. + + Full documentation: + + */ public struct GameCenterMatchmakingQueuesResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterMatchmakingQueue + /// The queues that the endpoint fetches. public let data: [GameCenterMatchmakingQueue] + /// The rule sets included in the response. public var included: [GameCenterMatchmakingRuleSet]? + /// The link representations of the response. public let links: PagedDocumentLinks public var meta: PagingInformation? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRule.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRule.swift index d4d560fbb..86a9c097d 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRule.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRule.swift @@ -1,10 +1,19 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRule + The data structure that represents a matchmaking rule. + + Full documentation: + + */ public struct GameCenterMatchmakingRule: Codable, Sendable, Identifiable { + /// The unique identifier for the rule. public let id: String public var links: ResourceLinks? public var type: String { "gameCenterMatchmakingRules" } + /// The attributes of the rule. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleCreateRequest.swift index 9157fcf78..a69917a3e 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleCreateRequest + The request body you use to create a rule. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleCreateRequest: Codable, Sendable, RequestBody { + /// The data structure of the request body. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleErrorsV1MetricResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleErrorsV1MetricResponse.swift index 1fdd4791d..57c94a7e7 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleErrorsV1MetricResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleErrorsV1MetricResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleErrorsV1MetricResponse + The response body for fetching the rule errors. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleErrorsV1MetricResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleResponse.swift index 57f6ea4ff..da29a85d7 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleResponse.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleResponse + The response body for endpoints that create or modify a rule. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleResponse: Codable, Sendable { + /// The rule that you create or modify. public let data: GameCenterMatchmakingRule public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSet.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSet.swift index 8d79d899e..a143430d0 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSet.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSet.swift @@ -1,11 +1,22 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleSet + The data structure that represents a rule set. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleSet: Codable, Sendable, Identifiable { + /// The unique identifier for the rule set. public let id: String public var links: ResourceLinks? + /// The type of resource. public var type: String { "gameCenterMatchmakingRuleSets" } + /// The attributes of the rule set. public var attributes: Attributes? + /// The relationships to other objects belonging to the rule set. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetCreateRequest.swift index ec5ca47a1..3f8a137eb 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleSetCreateRequest + The request body you use to create a rule set. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleSetCreateRequest: Codable, Sendable, RequestBody { + /// The data structure of the request body. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetResponse.swift index b68cebb77..2ed5659ec 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleSetResponse + The response body for endpoints that create, modify, or get a single rule. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleSetResponse: Codable, Sendable { + /// The rule set that you create, modify, or get. public let data: GameCenterMatchmakingRuleSet + /// The related objects included in the response. public var included: [Included]? public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTest.swift index 39edeaf46..2a42bdd04 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTest.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleSetTest + The data structure that represents the results of testing a rule set. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleSetTest: Codable, Sendable, Identifiable { + /// A unique identifier for the rule set. public let id: String + /// The link representations of the object. public var links: ResourceLinks? + /// The type of resource object. public var type: String { "gameCenterMatchmakingRuleSetTests" } + /// The object attributes. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTestCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTestCreateRequest.swift index db9f383ac..ff3c022c8 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTestCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTestCreateRequest.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleSetTestCreateRequest + The request body for testing the rules in a rule set. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleSetTestCreateRequest: Codable, Sendable, RequestBody { + /// The data structure for the request body. public let data: Data + /// The resource objects that Game Center uses in the test. public var included: [Included]? public init(data: Data, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTestResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTestResponse.swift index 24824d809..d42888d78 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTestResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetTestResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleSetTestResponse + The response body for testing a rule set. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleSetTestResponse: Codable, Sendable { public let data: GameCenterMatchmakingRuleSetTest public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetUpdateRequest.swift index 80c228082..a89cb7349 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleSetUpdateRequest + The request body you use to modify a rule set. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleSetUpdateRequest: Codable, Sendable, RequestBody { + /// The data structure of the request body. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetsResponse.swift index 1846f7b27..f24e5cb53 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleSetsResponse.swift @@ -1,10 +1,19 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleSetsResponse + The response body for endpoints that get multiple rule sets. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleSetsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterMatchmakingRuleSet + /// The rule sets that an endpoint gets. public let data: [GameCenterMatchmakingRuleSet] + /// The related objects included in the response. public var included: [Included]? public let links: PagedDocumentLinks public var meta: PagingInformation? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleUpdateRequest.swift index c791c38b5..419914587 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRuleUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRuleUpdateRequest + The request body you use to modify a rule. + + Full documentation: + + */ public struct GameCenterMatchmakingRuleUpdateRequest: Codable, Sendable, RequestBody { + /// The data structure of the request body. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRulesResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRulesResponse.swift index dc4490bf3..86d7a06b7 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRulesResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingRulesResponse.swift @@ -1,9 +1,17 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingRulesResponse + The response body for endpoints that get multiple rules. + + Full documentation: + + */ public struct GameCenterMatchmakingRulesResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterMatchmakingRule + /// The rules that the endpoint gets. public let data: [GameCenterMatchmakingRule] public let links: PagedDocumentLinks public var meta: PagingInformation? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingSessionsV1MetricResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingSessionsV1MetricResponse.swift index d86ebaea4..943804ee0 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingSessionsV1MetricResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingSessionsV1MetricResponse.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingSessionsV1MetricResponse + The response body for information about a successful matchmaking session. + + Full documentation: + + */ public struct GameCenterMatchmakingSessionsV1MetricResponse: Codable, Sendable, PagedResponse { + /// The data structure for the results of a successful matchmaking session. public let data: [Data] public let links: PagedDocumentLinks public var meta: PagingInformation? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeam.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeam.swift index 42ce01ed7..a71557ba2 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeam.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeam.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingTeam + The data structure that represents a team. + + Full documentation: + + */ public struct GameCenterMatchmakingTeam: Codable, Sendable, Identifiable { + /// The unique identifier for the team. public let id: String + /// The link representations of the object. public var links: ResourceLinks? + /// The type of resource object. public var type: String { "gameCenterMatchmakingTeams" } + /// The attributes of the team. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamAssignment.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamAssignment.swift index df964f8b9..fe866b6bb 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamAssignment.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamAssignment.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingTeamAssignment + The data structure that represents the assignment of a player to a team. + + Full documentation: + + */ public struct GameCenterMatchmakingTeamAssignment: Codable, Sendable { + /// A unique identifier for the player. public var playerId: String? + /// The name of the team that Game Center assigned the player to. public var team: String? public init(playerId: String? = nil, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamCreateRequest.swift index 7a6c34e7e..92170bf3c 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingTeamCreateRequest + The request body you use to create a team. + + Full documentation: + + */ public struct GameCenterMatchmakingTeamCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamResponse.swift index b7f7bc4d8..f6a39d495 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingTeamResponse + The response body for endpoints that create or modify a team. + + Full documentation: + + */ public struct GameCenterMatchmakingTeamResponse: Codable, Sendable { + /// The team that you create or modify. public let data: GameCenterMatchmakingTeam + /// The link representations of the object. public let links: DocumentLinks public init(data: GameCenterMatchmakingTeam, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamUpdateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamUpdateRequest.swift index 6d1f7014c..ddc3ad6d6 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamUpdateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingTeamUpdateRequest + The request body you use to modify a team. + + Full documentation: + + */ public struct GameCenterMatchmakingTeamUpdateRequest: Codable, Sendable, RequestBody { + /// The data structure of the request body. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamsResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamsResponse.swift index 6f2c72e08..6cf414b56 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamsResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTeamsResponse.swift @@ -1,10 +1,19 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingTeamsResponse + The response body for endpoints that get multiple teams. + + Full documentation: + + */ public struct GameCenterMatchmakingTeamsResponse: Codable, Sendable, PagedResponse { public typealias Data = GameCenterMatchmakingTeam + /// The teams that the endpoint fetches. public let data: [GameCenterMatchmakingTeam] + /// The link representations of the object. public let links: PagedDocumentLinks public var meta: PagingInformation? diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTestPlayerPropertyInlineCreate.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTestPlayerPropertyInlineCreate.swift index f277a7847..44d9cd3b1 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTestPlayerPropertyInlineCreate.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTestPlayerPropertyInlineCreate.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingTestPlayerPropertyInlineCreate + A resource object that represents a player’s properties when you create a request. + + Full documentation: + + */ public struct GameCenterMatchmakingTestPlayerPropertyInlineCreate: Codable, Sendable, Identifiable { + /// The identifier for the resource object. public var id: String? + /// The type of the resource object. public var type: String { "gameCenterMatchmakingTestPlayerProperties" } + /// The attributes of the resource object. public let attributes: Attributes public init(id: String? = nil, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTestRequestInlineCreate.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTestRequestInlineCreate.swift index c7a4aafaf..7fe439046 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTestRequestInlineCreate.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterMatchmakingTestRequestInlineCreate.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # GameCenterMatchmakingTestRequestInlineCreate + A data structure that represents a sample match request for testing a rule set. + + Full documentation: + + */ public struct GameCenterMatchmakingTestRequestInlineCreate: Codable, Sendable, Identifiable { + /// A unique identifier for the match request. public var id: String? + /// The type of resource object. public var type: String { "gameCenterMatchmakingTestRequests" } + /// The object attributes. public let attributes: Attributes + /// The object relationships. public var relationships: Relationships? public init(id: String? = nil, diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterPlayerAchievementSubmissionCreateRequest.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterPlayerAchievementSubmissionCreateRequest.swift index d3097820b..a262f7966 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterPlayerAchievementSubmissionCreateRequest.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterPlayerAchievementSubmissionCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterPlayerAchievementSubmissionCreateRequest + The request body you use to create an Game Center player achievement. + + Full documentation: + + */ public struct GameCenterPlayerAchievementSubmissionCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/GameCenter/GameCenterPlayerAchievementSubmissionResponse.swift b/Sources/Bagbutik-Models/GameCenter/GameCenterPlayerAchievementSubmissionResponse.swift index 2490c812d..57066eb94 100644 --- a/Sources/Bagbutik-Models/GameCenter/GameCenterPlayerAchievementSubmissionResponse.swift +++ b/Sources/Bagbutik-Models/GameCenter/GameCenterPlayerAchievementSubmissionResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # GameCenterPlayerAchievementSubmissionResponse + A response that contains a single Game Center player achievement resource. + + Full documentation: + + */ public struct GameCenterPlayerAchievementSubmissionResponse: Codable, Sendable { public let data: GameCenterPlayerAchievementSubmission public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/GameCenter/Location.swift b/Sources/Bagbutik-Models/GameCenter/Location.swift index e54e3a01d..33281a61e 100644 --- a/Sources/Bagbutik-Models/GameCenter/Location.swift +++ b/Sources/Bagbutik-Models/GameCenter/Location.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # Location + A representation of a device location. + + Full documentation: + + */ public struct Location: Codable, Sendable { + /// The latitude of the location. public var latitude: Double? + /// The longitude of the location. public var longitude: Double? public init(latitude: Double? = nil, diff --git a/Sources/Bagbutik-Models/GameCenter/Property.swift b/Sources/Bagbutik-Models/GameCenter/Property.swift index ac64e11a3..51172bdfd 100644 --- a/Sources/Bagbutik-Models/GameCenter/Property.swift +++ b/Sources/Bagbutik-Models/GameCenter/Property.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # Property + A representation of a game-specific property. + + Full documentation: + + */ public struct Property: Codable, Sendable { + /// The name of the property. public var key: String? + /// The value for the property. public var value: String? public init(key: String? = nil, diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomain.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomain.swift index 67392cf9d..ca2e6725e 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomain.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomain.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionDomain + The data structure that represents an alternative distribution domain resource. + + Full documentation: + + */ public struct AlternativeDistributionDomain: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainCreateRequest.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainCreateRequest.swift index 87d1e5279..ffeaa549b 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainCreateRequest.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionDomainCreateRequest + The request body you use to create an alternative distribution domain. + + Full documentation: + + */ public struct AlternativeDistributionDomainCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainResponse.swift index fe7220123..3f0ac8c9d 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionDomainResponse + A response that contains a single alternative distribution domain resource. + + Full documentation: + + */ public struct AlternativeDistributionDomainResponse: Codable, Sendable { public let data: AlternativeDistributionDomain public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainsResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainsResponse.swift index cb4a046a8..6fd370ae3 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainsResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionDomainsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionDomainsResponse + A response that contains a list of alternative distribution domain resources. + + Full documentation: + + */ public struct AlternativeDistributionDomainsResponse: Codable, Sendable, PagedResponse { public typealias Data = AlternativeDistributionDomain diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKey.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKey.swift index 6c6d4ba70..ce155fc7f 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKey.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKey.swift @@ -1,7 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionKey + The data structure that represents an alternative distribution key resource. + + For more information about the response that includes this alternative distribution key object, see [AlternativeDistributionKeyResponse](https://developer.apple.com/documentation/appstoreconnectapi/alternativedistributionkeyresponse). + + Full documentation: + + */ public struct AlternativeDistributionKey: Codable, Sendable, Identifiable { + /// An opaque resource ID that uniquely identifies the alternative distribution key. public let id: String public var links: ResourceLinks? public var type: String { "alternativeDistributionKeys" } diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeyCreateRequest.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeyCreateRequest.swift index 222bfc942..a0e08af9b 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeyCreateRequest.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeyCreateRequest.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionKeyCreateRequest + The request body you use to create an alternative distribution key. + + Use this object to create a new alternative distribution key association in App Store Connect. For more infomation about the request that includes this request body, see [Add an alternative distribution key](https://developer.apple.com/documentation/appstoreconnectapi/post-v1-alternativedistributionkeys). + + Full documentation: + + */ public struct AlternativeDistributionKeyCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeyResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeyResponse.swift index e6a273629..9f39f8e30 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeyResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeyResponse.swift @@ -1,6 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionKeyResponse + A response that contains a single alternative distribution key resource. + + This object is the response from the alternative distribution key endpoints. For more information about alternative distribution keys, see Creating and reading keys. + ``` + { + ``` + + Full documentation: + + */ public struct AlternativeDistributionKeyResponse: Codable, Sendable { public let data: AlternativeDistributionKey public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeysResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeysResponse.swift index 5b6f7d5b7..2b3a084fa 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeysResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionKeysResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionKeysResponse + A response that contains a list of alternative distribution keys. + + For more information about the response that includes this alternative distribution key object, see [AlternativeDistributionKeyResponse](https://developer.apple.com/documentation/appstoreconnectapi/alternativedistributionkeyresponse). + + Full documentation: + + */ public struct AlternativeDistributionKeysResponse: Codable, Sendable, PagedResponse { public typealias Data = AlternativeDistributionKey diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackage.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackage.swift index 04c698acd..1be6bb9a1 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackage.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackage.swift @@ -1,7 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackage + The data structure that represents an alternative distribution package resource. + + To learn more about the response that includes this alternative distribution package object, see [AlternativeDistributionPackageResponse](https://developer.apple.com/documentation/appstoreconnectapi/alternativedistributionpackageresponse). + + Full documentation: + + */ public struct AlternativeDistributionPackage: Codable, Sendable, Identifiable { + /// An opaque resource ID that uniquely identifies the alternative distribution package. public let id: String public var links: ResourceLinks? public var type: String { "alternativeDistributionPackages" } diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageCreateRequest.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageCreateRequest.swift index 25883d0ef..7577a8df1 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageCreateRequest.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageCreateRequest.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageCreateRequest + The request body you use to create an alternative distribution package. + + Use this object to create a new alternative distribution package in App Store Connect. For more information about the request that includes this request body, see [Create an alternative distribution package](https://developer.apple.com/documentation/appstoreconnectapi/post-v1-alternativedistributionpackages). + + Full documentation: + + */ public struct AlternativeDistributionPackageCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDelta.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDelta.swift index b3943b2b9..93e86d8a9 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDelta.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDelta.swift @@ -1,7 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageDelta + The data structure that represents an alternative distribution package delta resource. + + For more information about the responses that include alternative distribution package delta objects, see [AlternativeDistributionPackageDeltaResponse](https://developer.apple.com/documentation/appstoreconnectapi/alternativedistributionpackagedeltaresponse) or [AlternativeDistributionPackageDeltasResponse](https://developer.apple.com/documentation/appstoreconnectapi/alternativedistributionpackagedeltasresponse). + + Full documentation: + + */ public struct AlternativeDistributionPackageDelta: Codable, Sendable, Identifiable { + /// An opaque resource ID that uniquely identifies the alternative distribution package delta. public let id: String public var links: ResourceLinks? public var type: String { "alternativeDistributionPackageDeltas" } diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDeltaResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDeltaResponse.swift index 943f22d79..72e6c7250 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDeltaResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDeltaResponse.swift @@ -1,6 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageDeltaResponse + A response that contains a single alternative distribution package delta resource. + + This object is the response that contains a single alternative distribution package delta. For more information about alternative distribution package deltas see [Read information for alternative distribution package deltas](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-alternativedistributionpackagedeltas-_id_). The schema of the response body is below. + ``` + { + ``` + + Full documentation: + + */ public struct AlternativeDistributionPackageDeltaResponse: Codable, Sendable { public let data: AlternativeDistributionPackageDelta public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDeltasResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDeltasResponse.swift index 426582769..a38884d14 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDeltasResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageDeltasResponse.swift @@ -1,6 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageDeltasResponse + A response that contains a list of alternative distribution package delta resources. + + This object is the response that contains a list of alternative distribution package deltas. For more information about alternative distribution package deltas, see [List deltas information](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-alternativedistributionpackageversions-_id_-deltas). The schema of the response body is below. + ``` + { + ``` + + Full documentation: + + */ public struct AlternativeDistributionPackageDeltasResponse: Codable, Sendable, PagedResponse { public typealias Data = AlternativeDistributionPackageDelta diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageResponse.swift index c69927bc5..5ffa51a6c 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageResponse.swift @@ -1,6 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageResponse + A response that contains a single alternative distribution package resource. + + This object is the response that contains a single the alternative distribution package. For more information, see Creating and reading distribution packages. The schema of the response body is below. + ``` + { + ``` + + Full documentation: + + */ public struct AlternativeDistributionPackageResponse: Codable, Sendable { public let data: AlternativeDistributionPackage public var included: [AlternativeDistributionPackageVersion]? diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariant.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariant.swift index 725cb66cd..2690ad9d2 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariant.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariant.swift @@ -1,7 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageVariant + The data structure that represents an alternative distribution package variant resource. + + To learn more about the responses that include alternative distribution package variant objects, see [AlternativeDistributionPackageVariantResponse](https://developer.apple.com/documentation/appstoreconnectapi/alternativedistributionpackagevariantresponse) or [AlternativeDistributionPackageVariantsResponse](https://developer.apple.com/documentation/appstoreconnectapi/alternativedistributionpackagevariantsresponse). + + Full documentation: + + */ public struct AlternativeDistributionPackageVariant: Codable, Sendable, Identifiable { + /// An opaque resource ID that uniquely identifies the alternative distribution package variant. public let id: String public var links: ResourceLinks? public var type: String { "alternativeDistributionPackageVariants" } diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariantResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariantResponse.swift index 6a09dff57..d7b13a968 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariantResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariantResponse.swift @@ -1,6 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageVariantResponse + A response that contains a single alternative distribution package variant resource. + + This object is the response that contains a single alternative distribution package variant. For more information, see [Read information for an alternative distribution package variants](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-alternativedistributionpackagevariants-_id_). The schema of the response body is below. + ``` + { + ``` + + Full documentation: + + */ public struct AlternativeDistributionPackageVariantResponse: Codable, Sendable { public let data: AlternativeDistributionPackageVariant public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariantsResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariantsResponse.swift index 040b2346b..0a9f1ae9c 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariantsResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVariantsResponse.swift @@ -1,6 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageVariantsResponse + A response that contains a list of alternative distribution package variant resources. + + This object is the response that contains a list of alternative distribution package variants. For more information, see [List variants information](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-alternativedistributionpackageversions-_id_-variants). The schema of the response body is below. + ``` + { + ``` + + Full documentation: + + */ public struct AlternativeDistributionPackageVariantsResponse: Codable, Sendable, PagedResponse { public typealias Data = AlternativeDistributionPackageVariant diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersion.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersion.swift index af2fdb86a..e1718b514 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersion.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersion.swift @@ -1,7 +1,17 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageVersion + The data structure that represents an alternative distribution package version resource. + + For more information about the responses that includes alternative distribution package version objects, see [AlternativeDistributionPackageVersionResponse](https://developer.apple.com/documentation/appstoreconnectapi/alternativedistributionpackageversionresponse) or [AlternativeDistributionPackageVersionsResponse](https://developer.apple.com/documentation/appstoreconnectapi/alternativedistributionpackageversionsresponse). + + Full documentation: + + */ public struct AlternativeDistributionPackageVersion: Codable, Sendable, Identifiable { + /// An opaque resource ID that uniquely identifies the alternative distribution package version. public let id: String public var links: ResourceLinks? public var type: String { "alternativeDistributionPackageVersions" } diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersionResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersionResponse.swift index cbdfdbb12..79257a4ac 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersionResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersionResponse.swift @@ -1,6 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageVersionResponse + A response that contains a single alternative distribution package version resource. + + This object is the response that contains a single alternative distribution package version. For more information, see [Read information for an alternative distribution package version](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-alternativedistributionpackageversions-_id_). The schema of the response body is below. + ``` + { + ``` + + Full documentation: + + */ public struct AlternativeDistributionPackageVersionResponse: Codable, Sendable { public let data: AlternativeDistributionPackageVersion public var included: [Included]? diff --git a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersionsResponse.swift b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersionsResponse.swift index 1bb06bd06..7f78a6610 100644 --- a/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersionsResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/AlternativeDistributionPackageVersionsResponse.swift @@ -1,6 +1,18 @@ import Bagbutik_Core import Foundation +/** + # AlternativeDistributionPackageVersionsResponse + A response that contains a list of alternative distribution package version resources. + + This object is the response that contains a list of alternative distribution package versions. For more information, see [Read version information for an alternative distribution package](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-alternativedistributionpackages-_id_-versions). The schema of the response body is below. + ``` + { + ``` + + Full documentation: + + */ public struct AlternativeDistributionPackageVersionsResponse: Codable, Sendable, PagedResponse { public typealias Data = AlternativeDistributionPackageVersion diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomain.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomain.swift index 938285d76..83e4747f0 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomain.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomain.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceDomain + The data structure that represents an alternative marketplace domain resource. + + Full documentation: + + */ public struct MarketplaceDomain: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainCreateRequest.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainCreateRequest.swift index 15646e4e8..f8380cd31 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainCreateRequest.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceDomainCreateRequest + The request body you use to create an alternative marketplace domain. + + Full documentation: + + */ public struct MarketplaceDomainCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainResponse.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainResponse.swift index 95a5165c6..018c0da8b 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceDomainResponse + A response that contains a single alternative marketplace domain resource. + + Full documentation: + + */ public struct MarketplaceDomainResponse: Codable, Sendable { public let data: MarketplaceDomain public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainsResponse.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainsResponse.swift index c28aba32e..c722eafed 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainsResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceDomainsResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceDomainsResponse + A response that contains a list of alternative marketplace domain resources. + + Full documentation: + + */ public struct MarketplaceDomainsResponse: Codable, Sendable, PagedResponse { public typealias Data = MarketplaceDomain diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetail.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetail.swift index 0e10be655..45e55be7b 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetail.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetail.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceSearchDetail + The data structure that represents an alternative marketplace search detail resource. + + Full documentation: + + */ public struct MarketplaceSearchDetail: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailCreateRequest.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailCreateRequest.swift index a31be9274..81dd75ba5 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailCreateRequest.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceSearchDetailCreateRequest + The request body you use to create an alternative marketplace search detail. + + Full documentation: + + */ public struct MarketplaceSearchDetailCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailResponse.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailResponse.swift index b7540f9ca..dc4000e48 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceSearchDetailResponse + A response that contains a single alternative marketplace search detail resource. + + Full documentation: + + */ public struct MarketplaceSearchDetailResponse: Codable, Sendable { public let data: MarketplaceSearchDetail public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailUpdateRequest.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailUpdateRequest.swift index 611cd5e83..9653dff10 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailUpdateRequest.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceSearchDetailUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceSearchDetailUpdateRequest + The request body you use to update an alternative marketplace search detail. + + Full documentation: + + */ public struct MarketplaceSearchDetailUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhook.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhook.swift index 767f7ff2d..ce7f933a5 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhook.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhook.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceWebhook + The data structure that represents a marketplace webhook resource. + + Full documentation: + + */ public struct MarketplaceWebhook: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookCreateRequest.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookCreateRequest.swift index c7a0c296c..4795bc58e 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookCreateRequest.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookCreateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceWebhookCreateRequest + The request body you use to create a marketplace webhook url. + + Full documentation: + + */ public struct MarketplaceWebhookCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookResponse.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookResponse.swift index 1b6bcb51f..93842190c 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceWebhookResponse + A response that contains a single marketplace webhook resource. + + Use this object with [Add a marketplace webhook configuration](https://developer.apple.com/documentation/appstoreconnectapi/post-v1-marketplacewebhooks). + + Full documentation: + + */ public struct MarketplaceWebhookResponse: Codable, Sendable { public let data: MarketplaceWebhook public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookUpdateRequest.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookUpdateRequest.swift index 4880fb125..a1629d0c6 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookUpdateRequest.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhookUpdateRequest.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceWebhookUpdateRequest + The request body you use to update a marketplace webhook url. + + Full documentation: + + */ public struct MarketplaceWebhookUpdateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhooksResponse.swift b/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhooksResponse.swift index 64c96ecf2..1ed8098d1 100644 --- a/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhooksResponse.swift +++ b/Sources/Bagbutik-Models/Marketplaces/MarketplaceWebhooksResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # MarketplaceWebhooksResponse + A response that contains a list of a marketplace webhook resources. + + Use this object with [Read marketplace webhook information](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-marketplacewebhooks). + + Full documentation: + + */ public struct MarketplaceWebhooksResponse: Codable, Sendable, PagedResponse { public typealias Data = MarketplaceWebhook diff --git a/Sources/Bagbutik-Models/Provisioning/BundleId.swift b/Sources/Bagbutik-Models/Provisioning/BundleId.swift index 8c3d47da9..38b27fddd 100644 --- a/Sources/Bagbutik-Models/Provisioning/BundleId.swift +++ b/Sources/Bagbutik-Models/Provisioning/BundleId.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BundleId + The data structure that represents a Bundle IDs resource. + + Full documentation: + + */ public struct BundleId: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "bundleIds" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilitiesResponse.swift b/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilitiesResponse.swift index ed55316cf..6b90af25f 100644 --- a/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilitiesResponse.swift +++ b/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilitiesResponse.swift @@ -1,11 +1,21 @@ import Bagbutik_Core import Foundation +/** + # BundleIdCapabilitiesResponse + A response that contains a list of Bundle ID Capability resources. + + Full documentation: + + */ public struct BundleIdCapabilitiesResponse: Codable, Sendable, PagedResponse { public typealias Data = BundleIdCapability + /// The resource data. public let data: [BundleIdCapability] + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [BundleIdCapability], diff --git a/Sources/Bagbutik-Models/Provisioning/BundleIdCapability.swift b/Sources/Bagbutik-Models/Provisioning/BundleIdCapability.swift index e5ad97212..b63c1d63f 100644 --- a/Sources/Bagbutik-Models/Provisioning/BundleIdCapability.swift +++ b/Sources/Bagbutik-Models/Provisioning/BundleIdCapability.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # BundleIdCapability + The data structure that represents a Bundle ID Capabilities resource. + + Full documentation: + + */ public struct BundleIdCapability: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "bundleIdCapabilities" } + /// The resource’s attributes. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityCreateRequest.swift b/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityCreateRequest.swift index d69b83f30..ebb2ef5aa 100644 --- a/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityCreateRequest.swift +++ b/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BundleIdCapabilityCreateRequest + The request body you use to create a Bundle ID Capability. + + Full documentation: + + */ public struct BundleIdCapabilityCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityResponse.swift b/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityResponse.swift index a0312620f..b375701d3 100644 --- a/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityResponse.swift +++ b/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # BundleIdCapabilityResponse + A response that contains a single Bundle ID Capabilities resource. + + Full documentation: + + */ public struct BundleIdCapabilityResponse: Codable, Sendable { + /// The resource data. public let data: BundleIdCapability + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BundleIdCapability, diff --git a/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityUpdateRequest.swift b/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityUpdateRequest.swift index 3423b0408..1350628e2 100644 --- a/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityUpdateRequest.swift +++ b/Sources/Bagbutik-Models/Provisioning/BundleIdCapabilityUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BundleIdCapabilityUpdateRequest + The request body you use to update a Bundle ID Capability. + + Full documentation: + + */ public struct BundleIdCapabilityUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/Provisioning/BundleIdCreateRequest.swift b/Sources/Bagbutik-Models/Provisioning/BundleIdCreateRequest.swift index ba6f19232..abcd8a391 100644 --- a/Sources/Bagbutik-Models/Provisioning/BundleIdCreateRequest.swift +++ b/Sources/Bagbutik-Models/Provisioning/BundleIdCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BundleIdCreateRequest + The request body you use to create a Bundle ID. + + Full documentation: + + */ public struct BundleIdCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/Provisioning/BundleIdResponse.swift b/Sources/Bagbutik-Models/Provisioning/BundleIdResponse.swift index 29dd20d85..7111cfa7d 100644 --- a/Sources/Bagbutik-Models/Provisioning/BundleIdResponse.swift +++ b/Sources/Bagbutik-Models/Provisioning/BundleIdResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # BundleIdResponse + A response that contains a single Bundle IDs resource. + + Full documentation: + + */ public struct BundleIdResponse: Codable, Sendable { + /// The resource data. public let data: BundleId + /// The requested relationship data. public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BundleId, diff --git a/Sources/Bagbutik-Models/Provisioning/BundleIdUpdateRequest.swift b/Sources/Bagbutik-Models/Provisioning/BundleIdUpdateRequest.swift index a43f9bb64..a9799945c 100644 --- a/Sources/Bagbutik-Models/Provisioning/BundleIdUpdateRequest.swift +++ b/Sources/Bagbutik-Models/Provisioning/BundleIdUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BundleIdUpdateRequest + The request body you use to update a Bundle ID. + + Full documentation: + + */ public struct BundleIdUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/Provisioning/BundleIdsResponse.swift b/Sources/Bagbutik-Models/Provisioning/BundleIdsResponse.swift index 3dd5b9740..07fd6cc9d 100644 --- a/Sources/Bagbutik-Models/Provisioning/BundleIdsResponse.swift +++ b/Sources/Bagbutik-Models/Provisioning/BundleIdsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BundleIdsResponse + A response that contains a list of Bundle ID resources. + + Full documentation: + + */ public struct BundleIdsResponse: Codable, Sendable, PagedResponse { public typealias Data = BundleId + /// The resource data. public let data: [BundleId] + /// The requested relationship data. public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [BundleId], diff --git a/Sources/Bagbutik-Models/Provisioning/CapabilityOption.swift b/Sources/Bagbutik-Models/Provisioning/CapabilityOption.swift index 1df0951c2..1f5fe1525 100644 --- a/Sources/Bagbutik-Models/Provisioning/CapabilityOption.swift +++ b/Sources/Bagbutik-Models/Provisioning/CapabilityOption.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # CapabilityOption + An option within a capability setting. + + Full documentation: + + */ public struct CapabilityOption: Codable, Sendable { public var description: String? public var enabled: Bool? diff --git a/Sources/Bagbutik-Models/Provisioning/CapabilitySetting.swift b/Sources/Bagbutik-Models/Provisioning/CapabilitySetting.swift index 852779d80..02992641f 100644 --- a/Sources/Bagbutik-Models/Provisioning/CapabilitySetting.swift +++ b/Sources/Bagbutik-Models/Provisioning/CapabilitySetting.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # CapabilitySetting + An object that represents a capability setting for an app. + + Full documentation: + + */ public struct CapabilitySetting: Codable, Sendable { public var allowedInstances: AllowedInstances? public var description: String? diff --git a/Sources/Bagbutik-Models/Provisioning/Certificate.swift b/Sources/Bagbutik-Models/Provisioning/Certificate.swift index fe1e0e08d..cc126e205 100644 --- a/Sources/Bagbutik-Models/Provisioning/Certificate.swift +++ b/Sources/Bagbutik-Models/Provisioning/Certificate.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # Certificate + The data structure that represents a Certificates resource. + + Full documentation: + + */ public struct Certificate: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "certificates" } + /// The resource’s attributes. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/Provisioning/CertificateCreateRequest.swift b/Sources/Bagbutik-Models/Provisioning/CertificateCreateRequest.swift index 37cc93175..9c7be961f 100644 --- a/Sources/Bagbutik-Models/Provisioning/CertificateCreateRequest.swift +++ b/Sources/Bagbutik-Models/Provisioning/CertificateCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # CertificateCreateRequest + The request body you use to create a Certificate. + + Full documentation: + + */ public struct CertificateCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/Provisioning/CertificateResponse.swift b/Sources/Bagbutik-Models/Provisioning/CertificateResponse.swift index bab6532c3..4264cb6dd 100644 --- a/Sources/Bagbutik-Models/Provisioning/CertificateResponse.swift +++ b/Sources/Bagbutik-Models/Provisioning/CertificateResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # CertificateResponse + A response that contains a single Certificates resource. + + Full documentation: + + */ public struct CertificateResponse: Codable, Sendable { + /// The resource data. public let data: Certificate + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: Certificate, diff --git a/Sources/Bagbutik-Models/Provisioning/CertificatesResponse.swift b/Sources/Bagbutik-Models/Provisioning/CertificatesResponse.swift index beb2e2e6b..30b48f7f0 100644 --- a/Sources/Bagbutik-Models/Provisioning/CertificatesResponse.swift +++ b/Sources/Bagbutik-Models/Provisioning/CertificatesResponse.swift @@ -1,11 +1,21 @@ import Bagbutik_Core import Foundation +/** + # CertificatesResponse + A response that contains a list of Certificates resources. + + Full documentation: + + */ public struct CertificatesResponse: Codable, Sendable, PagedResponse { public typealias Data = Certificate + /// The resource data. public let data: [Certificate] + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information public var meta: PagingInformation? public init(data: [Certificate], diff --git a/Sources/Bagbutik-Models/Provisioning/Device.swift b/Sources/Bagbutik-Models/Provisioning/Device.swift index 81f0a9a91..a348d6713 100644 --- a/Sources/Bagbutik-Models/Provisioning/Device.swift +++ b/Sources/Bagbutik-Models/Provisioning/Device.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # Device + The data structure that represents a Devices resource. + + Full documentation: + + */ public struct Device: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "devices" } + /// The resource’s attributes. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/Provisioning/DeviceCreateRequest.swift b/Sources/Bagbutik-Models/Provisioning/DeviceCreateRequest.swift index 7a373f8f6..550f6b760 100644 --- a/Sources/Bagbutik-Models/Provisioning/DeviceCreateRequest.swift +++ b/Sources/Bagbutik-Models/Provisioning/DeviceCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # DeviceCreateRequest + The request body you use to create a Device. + + Full documentation: + + */ public struct DeviceCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/Provisioning/DeviceResponse.swift b/Sources/Bagbutik-Models/Provisioning/DeviceResponse.swift index cd1cb0a67..3cec31f2f 100644 --- a/Sources/Bagbutik-Models/Provisioning/DeviceResponse.swift +++ b/Sources/Bagbutik-Models/Provisioning/DeviceResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # DeviceResponse + A response that contains a single Devices resource. + + Full documentation: + + */ public struct DeviceResponse: Codable, Sendable { + /// The resource data. public let data: Device + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: Device, diff --git a/Sources/Bagbutik-Models/Provisioning/DeviceUpdateRequest.swift b/Sources/Bagbutik-Models/Provisioning/DeviceUpdateRequest.swift index b4edaa025..c3492e0dc 100644 --- a/Sources/Bagbutik-Models/Provisioning/DeviceUpdateRequest.swift +++ b/Sources/Bagbutik-Models/Provisioning/DeviceUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # DeviceUpdateRequest + The request body you use to update a Device. + + Full documentation: + + */ public struct DeviceUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/Provisioning/DevicesResponse.swift b/Sources/Bagbutik-Models/Provisioning/DevicesResponse.swift index ae3c3edde..ccf80614d 100644 --- a/Sources/Bagbutik-Models/Provisioning/DevicesResponse.swift +++ b/Sources/Bagbutik-Models/Provisioning/DevicesResponse.swift @@ -1,11 +1,21 @@ import Bagbutik_Core import Foundation +/** + # DevicesResponse + A response that contains a list of Devices resources. + + Full documentation: + + */ public struct DevicesResponse: Codable, Sendable, PagedResponse { public typealias Data = Device + /// The resource data. public let data: [Device] + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [Device], diff --git a/Sources/Bagbutik-Models/Provisioning/Profile.swift b/Sources/Bagbutik-Models/Provisioning/Profile.swift index ef8d75ce8..50becd50d 100644 --- a/Sources/Bagbutik-Models/Provisioning/Profile.swift +++ b/Sources/Bagbutik-Models/Provisioning/Profile.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # Profile + The data structure that represents a Profiles resource. + + Full documentation: + + */ public struct Profile: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "profiles" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/Provisioning/ProfileCreateRequest.swift b/Sources/Bagbutik-Models/Provisioning/ProfileCreateRequest.swift index 458dd3174..251168a04 100644 --- a/Sources/Bagbutik-Models/Provisioning/ProfileCreateRequest.swift +++ b/Sources/Bagbutik-Models/Provisioning/ProfileCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # ProfileCreateRequest + The request body you use to create a Profile. + + Full documentation: + + */ public struct ProfileCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/Provisioning/ProfileResponse.swift b/Sources/Bagbutik-Models/Provisioning/ProfileResponse.swift index 1655a35b2..1302034f3 100644 --- a/Sources/Bagbutik-Models/Provisioning/ProfileResponse.swift +++ b/Sources/Bagbutik-Models/Provisioning/ProfileResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # ProfileResponse + A response that contains a single Profiles resource. + + Full documentation: + + */ public struct ProfileResponse: Codable, Sendable { + /// The resource data. public let data: Profile public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: Profile, diff --git a/Sources/Bagbutik-Models/Provisioning/ProfilesResponse.swift b/Sources/Bagbutik-Models/Provisioning/ProfilesResponse.swift index 096fd0d70..19221886f 100644 --- a/Sources/Bagbutik-Models/Provisioning/ProfilesResponse.swift +++ b/Sources/Bagbutik-Models/Provisioning/ProfilesResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # ProfilesResponse + A response that contains a list of Profiles resources. + + Full documentation: + + */ public struct ProfilesResponse: Codable, Sendable, PagedResponse { public typealias Data = Profile + /// The resource data. public let data: [Profile] public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [Profile], diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReport.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReport.swift index fe31d927e..4604556a9 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReport.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReport.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReport + The data structure that represents an analytics report. + + To learn more about the response that includes this analytics report request object, see [AnalyticsReportResponse](https://developer.apple.com/documentation/appstoreconnectapi/analyticsreportresponse). + + Full documentation: + + */ public struct AnalyticsReport: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstance.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstance.swift index 1726d0198..7b284ff03 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstance.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstance.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportInstance + The data structure that represents an analytics report instance. + + To learn more about the response that includes this analytics report instance object, see [AnalyticsReportInstanceResponse](https://developer.apple.com/documentation/appstoreconnectapi/analyticsreportinstanceresponse). + + Full documentation: + + */ public struct AnalyticsReportInstance: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstanceResponse.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstanceResponse.swift index 69438eac2..c312bc4c0 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstanceResponse.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstanceResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportInstanceResponse + A response that contains a single analytics report instance resource. + + Use this object with [Read report instance information](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-analyticsreportinstances-_id_). + + Full documentation: + + */ public struct AnalyticsReportInstanceResponse: Codable, Sendable { public let data: AnalyticsReportInstance public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstancesResponse.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstancesResponse.swift index e27e121e9..7db20844f 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstancesResponse.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportInstancesResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportInstancesResponse + A response that contains a list of analytics report instance resources. + + Use this object with [Read a list of instances of a report](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-analyticsreports-_id_-instances). + + Full documentation: + + */ public struct AnalyticsReportInstancesResponse: Codable, Sendable, PagedResponse { public typealias Data = AnalyticsReportInstance diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequest.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequest.swift index 0a2477ac8..52237e8e5 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequest.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequest.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportRequest + The data structure that represents an analytics report request. + + To learn more about the response that includes this analytics report request object, see [AnalyticsReportRequestCreateRequest](https://developer.apple.com/documentation/appstoreconnectapi/analyticsreportrequestcreaterequest). + + Full documentation: + + */ public struct AnalyticsReportRequest: Codable, Sendable, Identifiable, RequestBody { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestCreateRequest.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestCreateRequest.swift index 1bbd124c9..24767eb4f 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestCreateRequest.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestCreateRequest.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportRequestCreateRequest + The request body you use to create an analytics report request. + + Use this object with [Request reports](https://developer.apple.com/documentation/appstoreconnectapi/post-v1-analyticsreportrequests). + + Full documentation: + + */ public struct AnalyticsReportRequestCreateRequest: Codable, Sendable, RequestBody { public let data: Data diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestResponse.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestResponse.swift index 3ebd287bf..c35f81821 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestResponse.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportRequestResponse + A response that contains a single analytics report request resource. + + Use this object with [Read report request information](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-analyticsreportrequests-_id_). + + Full documentation: + + */ public struct AnalyticsReportRequestResponse: Codable, Sendable { public let data: AnalyticsReportRequest public var included: [AnalyticsReport]? diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestsResponse.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestsResponse.swift index e1220e45f..b59f9c5cf 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestsResponse.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportRequestsResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportRequestsResponse + A response that contains a list of analytics report request resources. + + Use this object with [Read report requests](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-apps-_id_-analyticsreportrequests). + + Full documentation: + + */ public struct AnalyticsReportRequestsResponse: Codable, Sendable, PagedResponse { public typealias Data = AnalyticsReportRequest diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportResponse.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportResponse.swift index 16e478a14..2db62ffc4 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportResponse.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportResponse + A response that contains a single analytics report resource. + + Use this object with [Read report information](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-analyticsreports-_id_). + + Full documentation: + + */ public struct AnalyticsReportResponse: Codable, Sendable { public let data: AnalyticsReport public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegment.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegment.swift index 3543b0dd8..b71770347 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegment.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegment.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportSegment + The data structure that represents an analytics report segment. + + To learn more about the response that includes this analytics report segment object, see [AnalyticsReportSegmentResponse](https://developer.apple.com/documentation/appstoreconnectapi/analyticsreportsegmentresponse). + + Full documentation: + + */ public struct AnalyticsReportSegment: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegmentResponse.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegmentResponse.swift index b495c9707..348e044c2 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegmentResponse.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegmentResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportSegmentResponse + A response that contains a single analytics report segment resource. + + Use this object with [Read the details for a report segment](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-analyticsreportsegments-_id_). + + Full documentation: + + */ public struct AnalyticsReportSegmentResponse: Codable, Sendable { public let data: AnalyticsReportSegment public let links: DocumentLinks diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegmentsResponse.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegmentsResponse.swift index 40919ff3c..6b0ff0940 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegmentsResponse.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportSegmentsResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportSegmentsResponse + A response that contains a list of analytics report segment resources. + + Use this object with [Read the segments for a report](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-analyticsreportinstances-_id_-segments). + + Full documentation: + + */ public struct AnalyticsReportSegmentsResponse: Codable, Sendable, PagedResponse { public typealias Data = AnalyticsReportSegment diff --git a/Sources/Bagbutik-Models/Reporting/AnalyticsReportsResponse.swift b/Sources/Bagbutik-Models/Reporting/AnalyticsReportsResponse.swift index 0b31e58b2..2497e4ea7 100644 --- a/Sources/Bagbutik-Models/Reporting/AnalyticsReportsResponse.swift +++ b/Sources/Bagbutik-Models/Reporting/AnalyticsReportsResponse.swift @@ -1,6 +1,15 @@ import Bagbutik_Core import Foundation +/** + # AnalyticsReportsResponse + A response that contains a list of analytics report resources. + + Use this object with [Read reports for a specific request](https://developer.apple.com/documentation/appstoreconnectapi/get-v1-analyticsreportrequests-_id_-reports). + + Full documentation: + + */ public struct AnalyticsReportsResponse: Codable, Sendable, PagedResponse { public typealias Data = AnalyticsReport diff --git a/Sources/Bagbutik-Models/Reporting/DiagnosticInsight.swift b/Sources/Bagbutik-Models/Reporting/DiagnosticInsight.swift index 6a1711473..f30957fb9 100644 --- a/Sources/Bagbutik-Models/Reporting/DiagnosticInsight.swift +++ b/Sources/Bagbutik-Models/Reporting/DiagnosticInsight.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # DiagnosticInsight + The data structure that represents the Diagnostic Insight resource. + + Full documentation: + + */ public struct DiagnosticInsight: Codable, Sendable { public var direction: DiagnosticInsightDirection? public var insightType: DiagnosticInsightType? diff --git a/Sources/Bagbutik-Models/Reporting/DiagnosticLog.swift b/Sources/Bagbutik-Models/Reporting/DiagnosticLog.swift index 18abbddaa..13035c38e 100644 --- a/Sources/Bagbutik-Models/Reporting/DiagnosticLog.swift +++ b/Sources/Bagbutik-Models/Reporting/DiagnosticLog.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # DiagnosticLog + The data structure that represents the Diagnostic Logs resource. + + Full documentation: + + */ public struct DiagnosticLog: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/Reporting/DiagnosticLogCallStackNode.swift b/Sources/Bagbutik-Models/Reporting/DiagnosticLogCallStackNode.swift index f9ef27b11..6b22a4887 100644 --- a/Sources/Bagbutik-Models/Reporting/DiagnosticLogCallStackNode.swift +++ b/Sources/Bagbutik-Models/Reporting/DiagnosticLogCallStackNode.swift @@ -1,19 +1,39 @@ import Bagbutik_Core import Foundation +/** + # DiagnosticLogCallStackNode + Diagnostic information that describes a single line in a call stack. + + Full documentation: + + */ public struct DiagnosticLogCallStackNode: Codable, Sendable { + /// The memory address of the frame. public var address: String? + /// The name of the binary responsible for the frame. public var binaryName: String? + /// The unique identifier of the binary image that contains the frame. public var binaryUUID: String? + /// The file name of the file where the frame is defined. public var fileName: String? + /// The insight category that applies to the frame. public var insightsCategory: String? + /// A Boolean value that indicates whether the frame is the responsibility of your app. public var isBlameFrame: Bool? + /// The line number where the function is invoked. public var lineNumber: String? + /// The number of bytes the frame is offset from the start of the binary text segment, for unsymbolicated frames. public var offsetIntoBinaryTextSegment: String? + /// The number of bytes the frame is offset from the start of the function, for symbolicated frames. public var offsetIntoSymbol: String? + /// The unparsed frame from the log. public var rawFrame: String? + /// The number of samples that captured the frame. Samples are taken at consistent intervals, meaning a greater number of samples results in a greater value for the metric. public var sampleCount: Int? + /// An array of call stack frames. public var subFrames: [DiagnosticLogCallStackNode]? + /// The name of the symbol in your code. public var symbolName: String? public init(address: String? = nil, diff --git a/Sources/Bagbutik-Models/Reporting/DiagnosticLogs.swift b/Sources/Bagbutik-Models/Reporting/DiagnosticLogs.swift index 58455494d..97580e98b 100644 --- a/Sources/Bagbutik-Models/Reporting/DiagnosticLogs.swift +++ b/Sources/Bagbutik-Models/Reporting/DiagnosticLogs.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # diagnosticLogs + A response containing log data for a diagnostic signature. + + Full documentation: + + */ public struct DiagnosticLogs: Codable, Sendable { + /// An array of log data for a specific diagnostic signature. public var productData: [ProductData]? + /// The version of the App Store Connect API. public var version: String? public init(productData: [ProductData]? = nil, diff --git a/Sources/Bagbutik-Models/Reporting/DiagnosticSignature.swift b/Sources/Bagbutik-Models/Reporting/DiagnosticSignature.swift index 28d33c2cf..a447daf10 100644 --- a/Sources/Bagbutik-Models/Reporting/DiagnosticSignature.swift +++ b/Sources/Bagbutik-Models/Reporting/DiagnosticSignature.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # DiagnosticSignature + The data structure that represents the Diagnostic Signatures resource. + + Full documentation: + + */ public struct DiagnosticSignature: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a diagnostic signature. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "diagnosticSignatures" } + /// Attributes that describe the diagnostic signature resource. public var attributes: Attributes? public var relationships: Relationships? diff --git a/Sources/Bagbutik-Models/Reporting/DiagnosticSignaturesResponse.swift b/Sources/Bagbutik-Models/Reporting/DiagnosticSignaturesResponse.swift index 374aa5b6e..dbfc52421 100644 --- a/Sources/Bagbutik-Models/Reporting/DiagnosticSignaturesResponse.swift +++ b/Sources/Bagbutik-Models/Reporting/DiagnosticSignaturesResponse.swift @@ -1,11 +1,21 @@ import Bagbutik_Core import Foundation +/** + # DiagnosticSignaturesResponse + A response that contains a list of Diagnostic Signature resources. + + Full documentation: + + */ public struct DiagnosticSignaturesResponse: Codable, Sendable, PagedResponse { public typealias Data = DiagnosticSignature + /// An array of diagnostic signatures. public let data: [DiagnosticSignature] + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [DiagnosticSignature], diff --git a/Sources/Bagbutik-Models/Reporting/MetricsInsight.swift b/Sources/Bagbutik-Models/Reporting/MetricsInsight.swift index 3aabc9ce9..1ce02cd35 100644 --- a/Sources/Bagbutik-Models/Reporting/MetricsInsight.swift +++ b/Sources/Bagbutik-Models/Reporting/MetricsInsight.swift @@ -1,15 +1,31 @@ import Bagbutik_Core import Foundation +/** + # MetricsInsight + Results of an analysis of metric data for a single metric category for your app. + + Full documentation: + + */ public struct MetricsInsight: Codable, Sendable { + /// A Boolean value that indicates whether the insight is high impact, meaning the metrics show that the latest app version has a regression of 100% or more, compared with the average values of the metric from the previous app versions. public var highImpact: Bool? + /// The version number of the most current version of the app. public var latestVersion: String? + /// The maximum value of this metric for the latest app version, from the values in `populations`. public var maxLatestVersionValue: Double? + /// The specific measurement within the `metricCategory` that this insight analyzes. public var metric: String? + /// The category of the metric that this insight is about. public var metricCategory: MetricCategory? + /// An array of metrics organized by device type on the latest app version, that includes the percent change of the metric as compared with previous app versions. public var populations: [Populations]? + /// A list of previous app versions that the system uses to compare the current app version to, when calculating metric value regressions or trends. public var referenceVersions: String? + /// A metric subtype, which provides additional information about the source of the measurement. public var subSystemLabel: String? + /// A human-readable description of the trend. public var summaryString: String? public init(highImpact: Bool? = nil, diff --git a/Sources/Bagbutik-Models/Reporting/PerfPowerMetric.swift b/Sources/Bagbutik-Models/Reporting/PerfPowerMetric.swift index 6fc337c9f..fc33e995d 100644 --- a/Sources/Bagbutik-Models/Reporting/PerfPowerMetric.swift +++ b/Sources/Bagbutik-Models/Reporting/PerfPowerMetric.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # PerfPowerMetric + Unused. + + Full documentation: + + */ public struct PerfPowerMetric: Codable, Sendable, Identifiable { public let id: String public var links: ResourceLinks? diff --git a/Sources/Bagbutik-Models/Reporting/XcodeMetrics.swift b/Sources/Bagbutik-Models/Reporting/XcodeMetrics.swift index 6f44bba75..738ad09a8 100644 --- a/Sources/Bagbutik-Models/Reporting/XcodeMetrics.swift +++ b/Sources/Bagbutik-Models/Reporting/XcodeMetrics.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # xcodeMetrics + A response that contains power and performance measurements for your app. + + Full documentation: + + */ public struct XcodeMetrics: Codable, Sendable { + /// Analysis of data collected about the power and performance of your app that includes regressions and trends. public var insights: Insights? + /// An array of metrics data containing power and performance measurements for your app, organized by platform. public var productData: [ProductData]? + /// The current App Store Connect API version. public var version: String? public init(insights: Insights? = nil, diff --git a/Sources/Bagbutik-Models/TestFlight/AppsBetaTesterUsagesV1MetricResponse.swift b/Sources/Bagbutik-Models/TestFlight/AppsBetaTesterUsagesV1MetricResponse.swift index 0baf1f661..b800b195e 100644 --- a/Sources/Bagbutik-Models/TestFlight/AppsBetaTesterUsagesV1MetricResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/AppsBetaTesterUsagesV1MetricResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # AppsBetaTesterUsagesV1MetricResponse + A response that contains one or more beta app tester metric resources. + + Full documentation: + + */ public struct AppsBetaTesterUsagesV1MetricResponse: Codable, Sendable, PagedResponse { public let data: [Data] public var included: [BetaTester]? diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocation.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocation.swift index 495180d7f..1b9fe43c0 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocation.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocation.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BetaAppClipInvocation + The data structure that represents a Beta App Clip Invocations resource. + + Full documentation: + + */ public struct BetaAppClipInvocation: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Beta App Clip Invocations resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "betaAppClipInvocations" } + /// The attributes that describe the Beta App Clip Invocations resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationCreateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationCreateRequest.swift index 8977d6985..04d74adc4 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationCreateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationCreateRequest.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # BetaAppClipInvocationCreateRequest + The request body you use to create an App Clip invocation for testers. + + Full documentation: + + */ public struct BetaAppClipInvocationCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data + /// The relationship data to include in the response. public var included: [BetaAppClipInvocationLocalizationInlineCreate]? public init(data: Data, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalization.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalization.swift index 99ef1aa1c..d2053c76d 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalization.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalization.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # BetaAppClipInvocationLocalization + The data structure that represents a Beta App Clip Invocation Localizations resource. + + Full documentation: + + */ public struct BetaAppClipInvocationLocalization: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Beta App Clip Invocation Localization. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "betaAppClipInvocationLocalizations" } + /// The attributes that describe the Beta App Clip Invocation Localizations resource. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationCreateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationCreateRequest.swift index d6f8a1663..12fd134ec 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationCreateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaAppClipInvocationLocalizationCreateRequest + The request body you use to create a Beta App Clip Localization. + + Full documentation: + + */ public struct BetaAppClipInvocationLocalizationCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationInlineCreate.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationInlineCreate.swift index 18f0ca1e6..11aa96abd 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationInlineCreate.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationInlineCreate.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # BetaAppClipInvocationLocalizationInlineCreate + The data structure that represents a Beta App Clip Invocation Localization Inline Creates resource. + + Full documentation: + + */ public struct BetaAppClipInvocationLocalizationInlineCreate: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Beta App Clip Invocation Localization Inline Create resource. public var id: String? + /// The resource type. public var type: String { "betaAppClipInvocationLocalizations" } + /// The attributes that describe the Beta App Clip Invocation Localization Inline Creates resource. public let attributes: Attributes + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String? = nil, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationResponse.swift index 77de6d11c..c04236feb 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # BetaAppClipInvocationLocalizationResponse + A response that contains a single Beta App Clip Invocation Localizations resource. + + Full documentation: + + */ public struct BetaAppClipInvocationLocalizationResponse: Codable, Sendable { + /// The resource data. public let data: BetaAppClipInvocationLocalization + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BetaAppClipInvocationLocalization, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationUpdateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationUpdateRequest.swift index 22c0542c0..df77c4afd 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationLocalizationUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaAppClipInvocationLocalizationUpdateRequest + The request body you use to update localized text that appears on the App Clip card for testers. + + Full documentation: + + */ public struct BetaAppClipInvocationLocalizationUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationResponse.swift index 83d7a987c..9eec545df 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # BetaAppClipInvocationResponse + A response that contains a single Beta App Clip Invocations resource. + + Full documentation: + + */ public struct BetaAppClipInvocationResponse: Codable, Sendable { + /// The resource data. public let data: BetaAppClipInvocation + /// The requested relationship data. public var included: [BetaAppClipInvocationLocalization]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BetaAppClipInvocation, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationUpdateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationUpdateRequest.swift index 4fa944ede..9fed8576f 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppClipInvocationUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaAppClipInvocationUpdateRequest + The request body you use to update a Beta App Clip Invocation. + + Full documentation: + + */ public struct BetaAppClipInvocationUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppLocalization.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppLocalization.swift index d768f6907..40d6ff009 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppLocalization.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppLocalization.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BetaAppLocalization + The data structure that represents a Beta App Localizations resource. + + Full documentation: + + */ public struct BetaAppLocalization: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "betaAppLocalizations" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationCreateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationCreateRequest.swift index b7339a7dc..c6ae76a31 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationCreateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaAppLocalizationCreateRequest + The request body you use to create a Beta App Localization. + + Full documentation: + + */ public struct BetaAppLocalizationCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationResponse.swift index 894e6ac77..ed0b8e5bd 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # BetaAppLocalizationResponse + A response that contains a single Beta App Localizations resource. + + Full documentation: + + */ public struct BetaAppLocalizationResponse: Codable, Sendable { + /// The resource data. public let data: BetaAppLocalization public var included: [App]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BetaAppLocalization, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationUpdateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationUpdateRequest.swift index 03a8c3b23..fb87cdb9e 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaAppLocalizationUpdateRequest + The request body you use to update a Beta App Localization. + + Full documentation: + + */ public struct BetaAppLocalizationUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationsResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationsResponse.swift index c62fbec91..00a7f16fc 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationsResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppLocalizationsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # BetaAppLocalizationsResponse + A response that contains a list of Beta App Localization resources. + + Full documentation: + + */ public struct BetaAppLocalizationsResponse: Codable, Sendable, PagedResponse { public typealias Data = BetaAppLocalization + /// The resource data. public let data: [BetaAppLocalization] public var included: [App]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [BetaAppLocalization], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetail.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetail.swift index 1215adf19..49eb6c3e6 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetail.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetail.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BetaAppReviewDetail + The data structure that represents a Beta App Review Details resource. + + Full documentation: + + */ public struct BetaAppReviewDetail: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "betaAppReviewDetails" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailResponse.swift index 34cc8bb2c..0ef8ed34d 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # BetaAppReviewDetailResponse + A response that contains a single Beta App Review Details resource. + + Full documentation: + + */ public struct BetaAppReviewDetailResponse: Codable, Sendable { + /// The resource data. public let data: BetaAppReviewDetail public var included: [App]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BetaAppReviewDetail, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailUpdateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailUpdateRequest.swift index 00163ae9e..00527611f 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailUpdateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaAppReviewDetailUpdateRequest + The request body you use to update a Beta App Review Detail. + + Full documentation: + + */ public struct BetaAppReviewDetailUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailsResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailsResponse.swift index 00d186e83..326f92817 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailsResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewDetailsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # BetaAppReviewDetailsResponse + A response that contains a list of Beta App Review Detail resources. + + Full documentation: + + */ public struct BetaAppReviewDetailsResponse: Codable, Sendable, PagedResponse { public typealias Data = BetaAppReviewDetail + /// The resource data. public let data: [BetaAppReviewDetail] public var included: [App]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [BetaAppReviewDetail], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmission.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmission.swift index 240f06f14..ec4c1f9fc 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmission.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmission.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BetaAppReviewSubmission + The data structure that represents a Beta App Review Submissions resource. + + Full documentation: + + */ public struct BetaAppReviewSubmission: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "betaAppReviewSubmissions" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionCreateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionCreateRequest.swift index 47d7cdf27..7ae79a9e9 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionCreateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaAppReviewSubmissionCreateRequest + The request body you use to create a Beta App Review Submission. + + Full documentation: + + */ public struct BetaAppReviewSubmissionCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionResponse.swift index beaf63349..221c2e15f 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # BetaAppReviewSubmissionResponse + A response that contains a single Beta App Review Submissions resource. + + Full documentation: + + */ public struct BetaAppReviewSubmissionResponse: Codable, Sendable { + /// The resource data. public let data: BetaAppReviewSubmission public var included: [Build]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BetaAppReviewSubmission, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionsResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionsResponse.swift index 85099334b..d215a2b78 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionsResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaAppReviewSubmissionsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # BetaAppReviewSubmissionsResponse + A response that contains a list of Beta App Review Submission resources. + + Full documentation: + + */ public struct BetaAppReviewSubmissionsResponse: Codable, Sendable, PagedResponse { public typealias Data = BetaAppReviewSubmission + /// The resource data. public let data: [BetaAppReviewSubmission] public var included: [Build]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [BetaAppReviewSubmission], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalization.swift b/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalization.swift index fd3c788cb..9c762791c 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalization.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalization.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BetaBuildLocalization + The data structure that represents a Beta Build Localizations resource. + + Full documentation: + + */ public struct BetaBuildLocalization: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "betaBuildLocalizations" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationCreateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationCreateRequest.swift index 569c8c67a..ab7c3be64 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationCreateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaBuildLocalizationCreateRequest + The request body you use to create a Beta Build Localization. + + Full documentation: + + */ public struct BetaBuildLocalizationCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationResponse.swift index 83f5bb3cb..d935d4cae 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # BetaBuildLocalizationResponse + A response that contains a single Beta Build Localizations resource. + + Full documentation: + + */ public struct BetaBuildLocalizationResponse: Codable, Sendable { + /// The resource data. public let data: BetaBuildLocalization public var included: [Build]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BetaBuildLocalization, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationUpdateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationUpdateRequest.swift index 17fb99049..9e6198b1d 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationUpdateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaBuildLocalizationUpdateRequest + The request body you use to update a Beta Build Localization. + + Full documentation: + + */ public struct BetaBuildLocalizationUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationsResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationsResponse.swift index 4225d8a1f..4c00ddf50 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationsResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaBuildLocalizationsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # BetaBuildLocalizationsResponse + A response that contains a list of Beta Build Localization resources. + + Full documentation: + + */ public struct BetaBuildLocalizationsResponse: Codable, Sendable, PagedResponse { public typealias Data = BetaBuildLocalization + /// The resource data. public let data: [BetaBuildLocalization] public var included: [Build]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [BetaBuildLocalization], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaGroup.swift b/Sources/Bagbutik-Models/TestFlight/BetaGroup.swift index 68743a251..bc964aff7 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaGroup.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaGroup.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BetaGroup + The data structure that represents a Beta Groups resource. + + Full documentation: + + */ public struct BetaGroup: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "betaGroups" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaGroupBetaTestersLinkagesRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaGroupBetaTestersLinkagesRequest.swift index 738b72292..34a1efd5e 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaGroupBetaTestersLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaGroupBetaTestersLinkagesRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaGroupBetaTestersLinkagesRequest + A request body you use to add or remove beta testers from a beta group. + + Full documentation: + + */ public struct BetaGroupBetaTestersLinkagesRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. public let data: [Data] public init(data: [Data]) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaGroupBetaTestersLinkagesResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaGroupBetaTestersLinkagesResponse.swift index 75f9ccb45..4102fdfbb 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaGroupBetaTestersLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaGroupBetaTestersLinkagesResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # BetaGroupBetaTestersLinkagesResponse + A response body that contains a list of related resource IDs. + + Full documentation: + + */ public struct BetaGroupBetaTestersLinkagesResponse: Codable, Sendable, PagedResponse { + /// The object types and IDs of the related resources. public let data: [Data] + /// Navigational links including the self-link and links to the related data. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [Data], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaGroupBuildsLinkagesRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaGroupBuildsLinkagesRequest.swift index 13d36d660..e29b44a3f 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaGroupBuildsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaGroupBuildsLinkagesRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaGroupBuildsLinkagesRequest + A request body you use to add or remove builds from a beta group. + + Full documentation: + + */ public struct BetaGroupBuildsLinkagesRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. public let data: [Data] public init(data: [Data]) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaGroupBuildsLinkagesResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaGroupBuildsLinkagesResponse.swift index 5204d85f1..b87328c96 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaGroupBuildsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaGroupBuildsLinkagesResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # BetaGroupBuildsLinkagesResponse + A response body that contains a list of related resource IDs. + + Full documentation: + + */ public struct BetaGroupBuildsLinkagesResponse: Codable, Sendable, PagedResponse { + /// The object types and IDs of the related resources. public let data: [Data] + /// Navigational links including the self-link and links to the related data. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [Data], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaGroupCreateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaGroupCreateRequest.swift index 9e1f54bf3..40ec8ebdd 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaGroupCreateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaGroupCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaGroupCreateRequest + The request body you use to create a Beta Group. + + Full documentation: + + */ public struct BetaGroupCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaGroupResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaGroupResponse.swift index 667563a4a..52a765b87 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaGroupResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaGroupResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # BetaGroupResponse + A response that contains a single Beta Groups resource. + + Full documentation: + + */ public struct BetaGroupResponse: Codable, Sendable { + /// The resource data. public let data: BetaGroup public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BetaGroup, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaGroupUpdateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaGroupUpdateRequest.swift index 7fdee944c..6a313ac50 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaGroupUpdateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaGroupUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaGroupUpdateRequest + The request body you use to update a Beta Group. + + Full documentation: + + */ public struct BetaGroupUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaGroupsResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaGroupsResponse.swift index dd608fa8c..c0e58d36c 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaGroupsResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaGroupsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # BetaGroupsResponse + A response that contains a list of Beta Group resources. + + Full documentation: + + */ public struct BetaGroupsResponse: Codable, Sendable, PagedResponse { public typealias Data = BetaGroup + /// The resource data. public let data: [BetaGroup] public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [BetaGroup], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreement.swift b/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreement.swift index d254e2b61..96e71aad8 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreement.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreement.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BetaLicenseAgreement + The data structure that represents a Beta License Agreements resource. + + Full documentation: + + */ public struct BetaLicenseAgreement: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "betaLicenseAgreements" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementResponse.swift index 24e087dc3..bb0bd8589 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # BetaLicenseAgreementResponse + A response that contains a single Beta License Agreements resource. + + Full documentation: + + */ public struct BetaLicenseAgreementResponse: Codable, Sendable { + /// The resource data. public let data: BetaLicenseAgreement public var included: [App]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BetaLicenseAgreement, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementUpdateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementUpdateRequest.swift index 9c00177da..f06ed53b5 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementUpdateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaLicenseAgreementUpdateRequest + The request body you use to update a Beta License Agreement. + + Full documentation: + + */ public struct BetaLicenseAgreementUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementsResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementsResponse.swift index 5453bb304..9e6a4351e 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementsResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaLicenseAgreementsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # BetaLicenseAgreementsResponse + A response that contains a list of Beta License Agreement resources. + + Full documentation: + + */ public struct BetaLicenseAgreementsResponse: Codable, Sendable, PagedResponse { public typealias Data = BetaLicenseAgreement + /// The resource data. public let data: [BetaLicenseAgreement] public var included: [App]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [BetaLicenseAgreement], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTester.swift b/Sources/Bagbutik-Models/TestFlight/BetaTester.swift index 02c5f501d..1a7cd6b95 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTester.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTester.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BetaTester + The data structure that represents a Beta Testers resource. + + Full documentation: + + */ public struct BetaTester: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "betaTesters" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterAppsLinkagesRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterAppsLinkagesRequest.swift index 2107fa1f2..78d6c5bd0 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterAppsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterAppsLinkagesRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterAppsLinkagesRequest + A request body you use to remove an app from a beta tester. + + Full documentation: + + */ public struct BetaTesterAppsLinkagesRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. public let data: [Data] public init(data: [Data]) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterAppsLinkagesResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterAppsLinkagesResponse.swift index baf456de5..7f8234f08 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterAppsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterAppsLinkagesResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterAppsLinkagesResponse + A response body that contains a list of related resource IDs. + + Full documentation: + + */ public struct BetaTesterAppsLinkagesResponse: Codable, Sendable, PagedResponse { + /// The object types and IDs of the related resources. public let data: [Data] + /// Navigational links including the self-link and links to the related data. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [Data], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterBetaGroupsLinkagesRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterBetaGroupsLinkagesRequest.swift index bb3428bc3..d7d7a9753 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterBetaGroupsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterBetaGroupsLinkagesRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterBetaGroupsLinkagesRequest + A request body you use to add or remove beta groups from a beta tester. + + Full documentation: + + */ public struct BetaTesterBetaGroupsLinkagesRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. public let data: [Data] public init(data: [Data]) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterBetaGroupsLinkagesResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterBetaGroupsLinkagesResponse.swift index 3c82c0da4..53181ee5e 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterBetaGroupsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterBetaGroupsLinkagesResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterBetaGroupsLinkagesResponse + A response body that contains a list of related resource IDs. + + Full documentation: + + */ public struct BetaTesterBetaGroupsLinkagesResponse: Codable, Sendable, PagedResponse { + /// The object types and IDs of the related resources. public let data: [Data] + /// Navigational links including the self-link and links to the related data. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [Data], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterBuildsLinkagesRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterBuildsLinkagesRequest.swift index ac7f6081e..9e25572bc 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterBuildsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterBuildsLinkagesRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterBuildsLinkagesRequest + A request body you use to add or remove builds from a beta tester. + + Full documentation: + + */ public struct BetaTesterBuildsLinkagesRequest: Codable, Sendable, RequestBody { + /// The types and IDs of related resources. public let data: [Data] public init(data: [Data]) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterBuildsLinkagesResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterBuildsLinkagesResponse.swift index 646f0b7f6..2a33a407c 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterBuildsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterBuildsLinkagesResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterBuildsLinkagesResponse + A response body that contains a list of related resource IDs. + + Full documentation: + + */ public struct BetaTesterBuildsLinkagesResponse: Codable, Sendable, PagedResponse { + /// The object types and IDs of the related resources. public let data: [Data] + /// Navigational links including the self-link and links to the related data. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [Data], diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterCreateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterCreateRequest.swift index fb95a9219..da9914945 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterCreateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterCreateRequest + The request body you use to create a BetaTester. + + Full documentation: + + */ public struct BetaTesterCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitation.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitation.swift index 7622a8d88..d2e70938c 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitation.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitation.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterInvitation + The data structure that represents a Beta Tester Invitations resource. + + Full documentation: + + */ public struct BetaTesterInvitation: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "betaTesterInvitations" } public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitationCreateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitationCreateRequest.swift index 101428063..976b8202f 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitationCreateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitationCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterInvitationCreateRequest + The request body you use to create a Beta Tester Invitation. + + Full documentation: + + */ public struct BetaTesterInvitationCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitationResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitationResponse.swift index b56d43a37..42b0befc7 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitationResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterInvitationResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterInvitationResponse + A response that contains a single Beta Tester Invitations resource. + + Full documentation: + + */ public struct BetaTesterInvitationResponse: Codable, Sendable { + /// The resource data. public let data: BetaTesterInvitation + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BetaTesterInvitation, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterResponse.swift index 4905b686c..69bd19764 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterResponse + A response that contains a single Beta Testers resource. + + Full documentation: + + */ public struct BetaTesterResponse: Codable, Sendable { + /// The resource data. public let data: BetaTester public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BetaTester, diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTesterUsagesV1MetricResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaTesterUsagesV1MetricResponse.swift index 0a02c576f..f662cfd4d 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTesterUsagesV1MetricResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTesterUsagesV1MetricResponse.swift @@ -1,6 +1,13 @@ import Bagbutik_Core import Foundation +/** + # BetaTesterUsagesV1MetricResponse + A response that contains one or more beta tester usage metric resources. + + Full documentation: + + */ public struct BetaTesterUsagesV1MetricResponse: Codable, Sendable, PagedResponse { public let data: [Data] public let links: PagedDocumentLinks diff --git a/Sources/Bagbutik-Models/TestFlight/BetaTestersResponse.swift b/Sources/Bagbutik-Models/TestFlight/BetaTestersResponse.swift index e5ba12be6..a532a4813 100644 --- a/Sources/Bagbutik-Models/TestFlight/BetaTestersResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BetaTestersResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # BetaTestersResponse + A response that contains a list of Beta Tester resources. + + Full documentation: + + */ public struct BetaTestersResponse: Codable, Sendable, PagedResponse { public typealias Data = BetaTester + /// The resource data. public let data: [BetaTester] public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [BetaTester], diff --git a/Sources/Bagbutik-Models/TestFlight/BuildBetaDetail.swift b/Sources/Bagbutik-Models/TestFlight/BuildBetaDetail.swift index 62b5d1394..ce4e59782 100644 --- a/Sources/Bagbutik-Models/TestFlight/BuildBetaDetail.swift +++ b/Sources/Bagbutik-Models/TestFlight/BuildBetaDetail.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # BuildBetaDetail + The data structure that represents a Build Beta Details resource. + + Full documentation: + + */ public struct BuildBetaDetail: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "buildBetaDetails" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailResponse.swift b/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailResponse.swift index c7d6313b4..1ac1f4d92 100644 --- a/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # BuildBetaDetailResponse + A response that contains a single Build Beta Details resource. + + Full documentation: + + */ public struct BuildBetaDetailResponse: Codable, Sendable { + /// The resource data. public let data: BuildBetaDetail public var included: [Build]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BuildBetaDetail, diff --git a/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailUpdateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailUpdateRequest.swift index c0b6e87b2..264a1b90d 100644 --- a/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailUpdateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BuildBetaDetailUpdateRequest + The request body you use to update a Build Data Detail. + + Full documentation: + + */ public struct BuildBetaDetailUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailsResponse.swift b/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailsResponse.swift index 12a5ac7dd..63b405cf0 100644 --- a/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailsResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BuildBetaDetailsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # BuildBetaDetailsResponse + A response that contains a list of Build Beta Detail resources. + + Full documentation: + + */ public struct BuildBetaDetailsResponse: Codable, Sendable, PagedResponse { public typealias Data = BuildBetaDetail + /// The resource data. public let data: [BuildBetaDetail] public var included: [Build]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [BuildBetaDetail], diff --git a/Sources/Bagbutik-Models/TestFlight/BuildBetaNotification.swift b/Sources/Bagbutik-Models/TestFlight/BuildBetaNotification.swift index 6cae8020a..e8bf903e2 100644 --- a/Sources/Bagbutik-Models/TestFlight/BuildBetaNotification.swift +++ b/Sources/Bagbutik-Models/TestFlight/BuildBetaNotification.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # BuildBetaNotification + The data structure that represents a Build Beta Notifications resource. + + Full documentation: + + */ public struct BuildBetaNotification: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "buildBetaNotifications" } public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/BuildBetaNotificationCreateRequest.swift b/Sources/Bagbutik-Models/TestFlight/BuildBetaNotificationCreateRequest.swift index b56c2b297..cac892a6b 100644 --- a/Sources/Bagbutik-Models/TestFlight/BuildBetaNotificationCreateRequest.swift +++ b/Sources/Bagbutik-Models/TestFlight/BuildBetaNotificationCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # BuildBetaNotificationCreateRequest + The request body you use to create a Build Beta Notification. + + Full documentation: + + */ public struct BuildBetaNotificationCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/TestFlight/BuildBetaNotificationResponse.swift b/Sources/Bagbutik-Models/TestFlight/BuildBetaNotificationResponse.swift index 71801158d..4e49790c9 100644 --- a/Sources/Bagbutik-Models/TestFlight/BuildBetaNotificationResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/BuildBetaNotificationResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # BuildBetaNotificationResponse + A response that contains a single Build Beta Notifications resource. + + Full documentation: + + */ public struct BuildBetaNotificationResponse: Codable, Sendable { + /// The resource data. public let data: BuildBetaNotification + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: BuildBetaNotification, diff --git a/Sources/Bagbutik-Models/TestFlight/PreReleaseVersionsResponse.swift b/Sources/Bagbutik-Models/TestFlight/PreReleaseVersionsResponse.swift index 37cefa774..1a6bd0475 100644 --- a/Sources/Bagbutik-Models/TestFlight/PreReleaseVersionsResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/PreReleaseVersionsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # PreReleaseVersionsResponse + A response that contains a list of Pre-Release Version resources. + + Full documentation: + + */ public struct PreReleaseVersionsResponse: Codable, Sendable, PagedResponse { public typealias Data = PrereleaseVersion + /// The resource data. public let data: [PrereleaseVersion] public var included: [Included]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [PrereleaseVersion], diff --git a/Sources/Bagbutik-Models/TestFlight/PrereleaseVersion.swift b/Sources/Bagbutik-Models/TestFlight/PrereleaseVersion.swift index 41bcf2b90..a81a0fdeb 100644 --- a/Sources/Bagbutik-Models/TestFlight/PrereleaseVersion.swift +++ b/Sources/Bagbutik-Models/TestFlight/PrereleaseVersion.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # PrereleaseVersion + The data structure that represents a Prerelease Versions resource. + + Full documentation: + + */ public struct PrereleaseVersion: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "preReleaseVersions" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/TestFlight/PrereleaseVersionResponse.swift b/Sources/Bagbutik-Models/TestFlight/PrereleaseVersionResponse.swift index 93b2db029..809d4b397 100644 --- a/Sources/Bagbutik-Models/TestFlight/PrereleaseVersionResponse.swift +++ b/Sources/Bagbutik-Models/TestFlight/PrereleaseVersionResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # PrereleaseVersionResponse + A response that contains a single Prerelease Versions resource. + + Full documentation: + + */ public struct PrereleaseVersionResponse: Codable, Sendable { + /// The resource data. public let data: PrereleaseVersion public var included: [Included]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: PrereleaseVersion, diff --git a/Sources/Bagbutik-Models/Users/User.swift b/Sources/Bagbutik-Models/Users/User.swift index b73525ccb..970f8096c 100644 --- a/Sources/Bagbutik-Models/Users/User.swift +++ b/Sources/Bagbutik-Models/Users/User.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # User + The data structure that represents a Users resource. + + Full documentation: + + */ public struct User: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "users" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/Users/UserInvitation.swift b/Sources/Bagbutik-Models/Users/UserInvitation.swift index a91dd8e19..dfb3dea0b 100644 --- a/Sources/Bagbutik-Models/Users/UserInvitation.swift +++ b/Sources/Bagbutik-Models/Users/UserInvitation.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # UserInvitation + The data structure that represents a User Invitations resource. + + Full documentation: + + */ public struct UserInvitation: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies the resource. public let id: String + /// Navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "userInvitations" } + /// The resource’s attributes. public var attributes: Attributes? + /// Navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/Users/UserInvitationCreateRequest.swift b/Sources/Bagbutik-Models/Users/UserInvitationCreateRequest.swift index 7a9f392a4..ae639ca67 100644 --- a/Sources/Bagbutik-Models/Users/UserInvitationCreateRequest.swift +++ b/Sources/Bagbutik-Models/Users/UserInvitationCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # UserInvitationCreateRequest + The request body you use to create a User Invitation. + + Full documentation: + + */ public struct UserInvitationCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/Users/UserInvitationResponse.swift b/Sources/Bagbutik-Models/Users/UserInvitationResponse.swift index 19b74aa31..e6030319f 100644 --- a/Sources/Bagbutik-Models/Users/UserInvitationResponse.swift +++ b/Sources/Bagbutik-Models/Users/UserInvitationResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # UserInvitationResponse + A response that contains a single User Invitations resource. + + Full documentation: + + */ public struct UserInvitationResponse: Codable, Sendable { + /// The resource data. public let data: UserInvitation public var included: [App]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: UserInvitation, diff --git a/Sources/Bagbutik-Models/Users/UserInvitationsResponse.swift b/Sources/Bagbutik-Models/Users/UserInvitationsResponse.swift index b4f73ffe2..c59ece3c2 100644 --- a/Sources/Bagbutik-Models/Users/UserInvitationsResponse.swift +++ b/Sources/Bagbutik-Models/Users/UserInvitationsResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # UserInvitationsResponse + A response that contains a list of User Invitations resources. + + Full documentation: + + */ public struct UserInvitationsResponse: Codable, Sendable, PagedResponse { public typealias Data = UserInvitation + /// The resource data. public let data: [UserInvitation] public var included: [App]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [UserInvitation], diff --git a/Sources/Bagbutik-Models/Users/UserResponse.swift b/Sources/Bagbutik-Models/Users/UserResponse.swift index dbb7cfbee..242850e4a 100644 --- a/Sources/Bagbutik-Models/Users/UserResponse.swift +++ b/Sources/Bagbutik-Models/Users/UserResponse.swift @@ -1,9 +1,18 @@ import Bagbutik_Core import Foundation +/** + # UserResponse + A response that contains a single Users resource. + + Full documentation: + + */ public struct UserResponse: Codable, Sendable { + /// The resource data. public let data: User public var included: [App]? + /// Navigational links that include the self-link. public let links: DocumentLinks public init(data: User, diff --git a/Sources/Bagbutik-Models/Users/UserUpdateRequest.swift b/Sources/Bagbutik-Models/Users/UserUpdateRequest.swift index 946adf3a7..a4096bd55 100644 --- a/Sources/Bagbutik-Models/Users/UserUpdateRequest.swift +++ b/Sources/Bagbutik-Models/Users/UserUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # UserUpdateRequest + The request body you use to update a User. + + Full documentation: + + */ public struct UserUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/Users/UserVisibleAppsLinkagesRequest.swift b/Sources/Bagbutik-Models/Users/UserVisibleAppsLinkagesRequest.swift index 04f8e9029..ed416a5c4 100644 --- a/Sources/Bagbutik-Models/Users/UserVisibleAppsLinkagesRequest.swift +++ b/Sources/Bagbutik-Models/Users/UserVisibleAppsLinkagesRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # UserVisibleAppsLinkagesRequest + A request body you use to add or remove visible apps from a user. + + Full documentation: + + */ public struct UserVisibleAppsLinkagesRequest: Codable, Sendable, RequestBody { + /// The object types and IDs of the related resources. public let data: [Data] public init(data: [Data]) { diff --git a/Sources/Bagbutik-Models/Users/UserVisibleAppsLinkagesResponse.swift b/Sources/Bagbutik-Models/Users/UserVisibleAppsLinkagesResponse.swift index 52dbcc315..615381410 100644 --- a/Sources/Bagbutik-Models/Users/UserVisibleAppsLinkagesResponse.swift +++ b/Sources/Bagbutik-Models/Users/UserVisibleAppsLinkagesResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # UserVisibleAppsLinkagesResponse + A response body that contains a list of related resource IDs. + + Full documentation: + + */ public struct UserVisibleAppsLinkagesResponse: Codable, Sendable, PagedResponse { + /// The object types and IDs of the related resources. public let data: [Data] + /// Navigational links including the self-link and links to the related data. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [Data], diff --git a/Sources/Bagbutik-Models/Users/UsersResponse.swift b/Sources/Bagbutik-Models/Users/UsersResponse.swift index 04ad78973..18bebd766 100644 --- a/Sources/Bagbutik-Models/Users/UsersResponse.swift +++ b/Sources/Bagbutik-Models/Users/UsersResponse.swift @@ -1,12 +1,22 @@ import Bagbutik_Core import Foundation +/** + # UsersResponse + A response that contains a list of Users resources. + + Full documentation: + + */ public struct UsersResponse: Codable, Sendable, PagedResponse { public typealias Data = User + /// The resource data. public let data: [User] public var included: [App]? + /// Navigational links that include the self-link. public let links: PagedDocumentLinks + /// Paging information. public var meta: PagingInformation? public init(data: [User], diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiAction.swift b/Sources/Bagbutik-Models/XcodeCloud/CiAction.swift index 3caba07b1..a7715caf0 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiAction.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiAction.swift @@ -1,14 +1,29 @@ import Bagbutik_Core import Foundation +/** + # CiAction + The data structure that represents an Xcode Cloud workflow action resource. + + Full documentation: + + */ public struct CiAction: Codable, Sendable { + /// The type of the action. public var actionType: CiActionType? + /// A type that indicates whether a build’s artifact is eligible for release on the App Store. public var buildDistributionAudience: BuildAudienceType? + /// A string that describes the destination Xcode Cloud uses for an action. public var destination: Destination? + /// A Boolean value that indicates whether the action must succeed in order for a build to succeed. public var isRequiredToPass: Bool? + /// The name of the action; for example, archive or test. public var name: String? + /// The platform Xcode Cloud uses for the action. public var platform: Platform? + /// The name of the scheme that Xcode Cloud uses to perform the action. public var scheme: String? + /// An action’s test configuration. Only set this field for test actions. public var testConfiguration: TestConfiguration? public init(actionType: CiActionType? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiArtifact.swift b/Sources/Bagbutik-Models/XcodeCloud/CiArtifact.swift index 0c0131c57..933c16bf4 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiArtifact.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiArtifact.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # CiArtifact + The data structure that represents the output of an Xcode Cloud build action resource. + + Full documentation: + + */ public struct CiArtifact: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an Artifacts resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "ciArtifacts" } + /// The attributes that describe the Artifacts resource. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiArtifactResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiArtifactResponse.swift index 899293079..617713139 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiArtifactResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiArtifactResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # CiArtifactResponse + A response that contains a single Artifacts resource. + + Full documentation: + + */ public struct CiArtifactResponse: Codable, Sendable { + /// The resource data. public let data: CiArtifact + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: CiArtifact, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiArtifactsResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiArtifactsResponse.swift index e104a421b..a7889fd6e 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiArtifactsResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiArtifactsResponse.swift @@ -1,11 +1,21 @@ import Bagbutik_Core import Foundation +/** + # CiArtifactsResponse + A response that contains a list of Artifacts resources. + + Full documentation: + + */ public struct CiArtifactsResponse: Codable, Sendable, PagedResponse { public typealias Data = CiArtifact + /// The resource data. public let data: [CiArtifact] + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [CiArtifact], diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiBranchPatterns.swift b/Sources/Bagbutik-Models/XcodeCloud/CiBranchPatterns.swift index 6c57c4825..8972edb6d 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiBranchPatterns.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiBranchPatterns.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # CiBranchPatterns + Case-sensitive patterns Xcode Cloud uses to determine if a change meets branch names you configure for a workflow’s start condition. + + Full documentation: + + */ public struct CiBranchPatterns: Codable, Sendable { + /// ​A Boolean value that indicates whether a start condition’s settings apply to all branches. If `true`, the `patterns` attribute isn’t expected. If `false`, the `patterns` attribute is required. public var isAllMatch: Bool? + /// The list of case-sensitive patterns Xcode Cloud uses to determine if a change meets branch names you configure for a workflow’s start condition. public var patterns: [Patterns]? public init(isAllMatch: Bool? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiBranchStartCondition.swift b/Sources/Bagbutik-Models/XcodeCloud/CiBranchStartCondition.swift index 4728d5aed..f7b841990 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiBranchStartCondition.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiBranchStartCondition.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CiBranchStartCondition + Settings for a start condition that starts a build if a branch changes. + + Full documentation: + + */ public struct CiBranchStartCondition: Codable, Sendable { + /// A Boolean value that indicates whether Xcode Cloud automatically cancels or skips builds. public var autoCancel: Bool? + /// Settings Xcode Cloud uses to determine whether a change to a branch should start a new build or not. public var filesAndFoldersRule: CiFilesAndFoldersRule? + /// The source branch name and custom patterns you configure for a workflow that starts a new build for changes to a branch. public var source: CiBranchPatterns? public init(autoCancel: Bool? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiBuildAction.swift b/Sources/Bagbutik-Models/XcodeCloud/CiBuildAction.swift index 4c11af4d9..7d5dd21d7 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiBuildAction.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiBuildAction.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiBuildAction + The data structure that represents a Build Actions resource. + + Full documentation: + + */ public struct CiBuildAction: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Build Actions resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "ciBuildActions" } + /// The attributes that describe the Build Actions resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiBuildActionResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiBuildActionResponse.swift index 42c690990..7ad18f029 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiBuildActionResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiBuildActionResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CiBuildActionResponse + A response that contains a single Build Actions resource. + + Full documentation: + + */ public struct CiBuildActionResponse: Codable, Sendable { + /// The resource data. public let data: CiBuildAction + /// The requested relationship data. public var included: [CiBuildRun]? + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: CiBuildAction, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiBuildActionsResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiBuildActionsResponse.swift index 3df95c3c1..270de8d42 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiBuildActionsResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiBuildActionsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiBuildActionsResponse + A response that contains a list of Build Actions resources. + + Full documentation: + + */ public struct CiBuildActionsResponse: Codable, Sendable, PagedResponse { public typealias Data = CiBuildAction + /// The resource data. public let data: [CiBuildAction] + /// The requested relationship data. public var included: [CiBuildRun]? + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [CiBuildAction], diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiBuildRun.swift b/Sources/Bagbutik-Models/XcodeCloud/CiBuildRun.swift index 61760b647..05de0362e 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiBuildRun.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiBuildRun.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiBuildRun + The data structure that represents a Build Runs resource. + + Full documentation: + + */ public struct CiBuildRun: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Build Runs resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "ciBuildRuns" } + /// The attributes that describe the Build Runs resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunCreateRequest.swift b/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunCreateRequest.swift index 50bc337d4..7cd7b0c6e 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunCreateRequest.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # CiBuildRunCreateRequest + The request body you use to start a new Xcode Cloud build. + + Full documentation: + + */ public struct CiBuildRunCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunResponse.swift index ae07a1d39..6ad724afa 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CiBuildRunResponse + A response that contains a single Build Runs resource. + + Full documentation: + + */ public struct CiBuildRunResponse: Codable, Sendable { + /// The resource data. public let data: CiBuildRun + /// The requested relationship data. public var included: [Included]? + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: CiBuildRun, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunsResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunsResponse.swift index 3bca31867..d30edf9c7 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunsResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiBuildRunsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiBuildRunsResponse + A response that contains a list of Build Runs resources. + + Full documentation: + + */ public struct CiBuildRunsResponse: Codable, Sendable, PagedResponse { public typealias Data = CiBuildRun + /// The resource data. public let data: [CiBuildRun] + /// The requested relationship data. public var included: [Included]? + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [CiBuildRun], diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiFilesAndFoldersRule.swift b/Sources/Bagbutik-Models/XcodeCloud/CiFilesAndFoldersRule.swift index 827d2f3c2..6d8ff82d7 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiFilesAndFoldersRule.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiFilesAndFoldersRule.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # CiFilesAndFoldersRule + Settings Xcode Cloud uses to determine whether a change should start a new build or not. + + Full documentation: + + */ public struct CiFilesAndFoldersRule: Codable, Sendable { + /// Directory and file information Xcode Cloud uses to determine if a change to a file or directory matches a custom start condition. public var matchers: [CiStartConditionFileMatcher]? + /// A string that indicates whether a workflow’s start condition’s Files and Folders setting should start a new build or not for a change. public var mode: Mode? public init(matchers: [CiStartConditionFileMatcher]? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiGitUser.swift b/Sources/Bagbutik-Models/XcodeCloud/CiGitUser.swift index 90a089df2..338b4d03f 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiGitUser.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiGitUser.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # CiGitUser + The data structure that represents a Git Users resource. + + Full documentation: + + */ public struct CiGitUser: Codable, Sendable { + /// The URL to the Git user’s avatar image. public var avatarUrl: String? + /// The name of the Git user. public var displayName: String? public init(avatarUrl: String? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiIssue.swift b/Sources/Bagbutik-Models/XcodeCloud/CiIssue.swift index 581d6515a..c8097ccfd 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiIssue.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiIssue.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # CiIssue + The data structure that represents an Issues resource. + + Full documentation: + + */ public struct CiIssue: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an Issues resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "ciIssues" } + /// The attributes that describe the Issues resource. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiIssueCounts.swift b/Sources/Bagbutik-Models/XcodeCloud/CiIssueCounts.swift index 7de8ca4b1..1a4fc0029 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiIssueCounts.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiIssueCounts.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # CiIssueCounts + The data structure that represents an Issue Counts resource. + + Full documentation: + + */ public struct CiIssueCounts: Codable, Sendable { + /// The number of analyzer warnings. public var analyzerWarnings: Int? + /// The number of errors. public var errors: Int? + /// The number of failing tests. public var testFailures: Int? + /// The number of warnings. public var warnings: Int? public init(analyzerWarnings: Int? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiIssueResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiIssueResponse.swift index 5f8233b62..63e912c00 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiIssueResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiIssueResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # CiIssueResponse + A response that contains a single Issues resource. + + Full documentation: + + */ public struct CiIssueResponse: Codable, Sendable { + /// The resource data. public let data: CiIssue + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: CiIssue, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiIssuesResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiIssuesResponse.swift index 46b39025d..47ece4ad9 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiIssuesResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiIssuesResponse.swift @@ -1,11 +1,21 @@ import Bagbutik_Core import Foundation +/** + # CiIssuesResponse + A response that contains a list of Issues resources. + + Full documentation: + + */ public struct CiIssuesResponse: Codable, Sendable, PagedResponse { public typealias Data = CiIssue + /// The resource data. public let data: [CiIssue] + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [CiIssue], diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersion.swift b/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersion.swift index 156138b1d..549d6a45e 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersion.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersion.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiMacOsVersion + The data structure that represents a macOS Versions resource. + + Full documentation: + + */ public struct CiMacOsVersion: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a macOS Versions resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "ciMacOsVersions" } + /// The attributes that describe the macOS Versions resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersionResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersionResponse.swift index febfe87b2..74343b10b 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersionResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersionResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CiMacOsVersionResponse + A response that contains a single macOS Versions resource. + + Full documentation: + + */ public struct CiMacOsVersionResponse: Codable, Sendable { + /// The resource data. public let data: CiMacOsVersion + /// The requested relationship data. public var included: [CiXcodeVersion]? + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: CiMacOsVersion, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersionsResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersionsResponse.swift index 3f7ab2229..eebc105fc 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersionsResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiMacOsVersionsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiMacOsVersionsResponse + A response that contains a list of macOS Versions resources. + + Full documentation: + + */ public struct CiMacOsVersionsResponse: Codable, Sendable, PagedResponse { public typealias Data = CiMacOsVersion + /// The resource data. public let data: [CiMacOsVersion] + /// The requested relationship data. public var included: [CiXcodeVersion]? + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [CiMacOsVersion], diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiProduct.swift b/Sources/Bagbutik-Models/XcodeCloud/CiProduct.swift index 26ccebc4c..2a7ae83e7 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiProduct.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiProduct.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiProduct + The data structure that represents a Products resource. + + Full documentation: + + */ public struct CiProduct: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Products resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "ciProducts" } + /// The attributes that describe the Products resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiProductResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiProductResponse.swift index 21fcb75c4..aacb1112d 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiProductResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiProductResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CiProductResponse + A response that contains a single Products resource. + + Full documentation: + + */ public struct CiProductResponse: Codable, Sendable { + /// The resource data. public let data: CiProduct + /// The requested relationship data. public var included: [Included]? + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: CiProduct, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiProductsResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiProductsResponse.swift index b21fdb625..92342e72b 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiProductsResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiProductsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiProductsResponse + A response that contains a list of Products resources. + + Full documentation: + + */ public struct CiProductsResponse: Codable, Sendable, PagedResponse { public typealias Data = CiProduct + /// The resource data. public let data: [CiProduct] + /// The requested relationship data. public var included: [Included]? + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [CiProduct], diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiPullRequestStartCondition.swift b/Sources/Bagbutik-Models/XcodeCloud/CiPullRequestStartCondition.swift index d23fbd6ae..295dcf4a6 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiPullRequestStartCondition.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiPullRequestStartCondition.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # CiPullRequestStartCondition + Settings for a start condition that starts a build if a pull request changes. + + Full documentation: + + */ public struct CiPullRequestStartCondition: Codable, Sendable { + /// A Boolean value that indicates whether Xcode Cloud automatically cancels or skips builds. public var autoCancel: Bool? + /// The destination branch name and custom patterns you configure for a workflow that starts a new build for changes to a pull request. public var destination: CiBranchPatterns? + /// The custom rule that determines whether Xcode Cloud starts a build or not based on a pull request’s changes to files. public var filesAndFoldersRule: CiFilesAndFoldersRule? + /// The source branch name and custom patterns you configure for a workflow that starts a new build for changes to a pull request. public var source: CiBranchPatterns? public init(autoCancel: Bool? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiScheduledStartCondition.swift b/Sources/Bagbutik-Models/XcodeCloud/CiScheduledStartCondition.swift index 6b6fe3551..7d9129d91 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiScheduledStartCondition.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiScheduledStartCondition.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # CiScheduledStartCondition + Settings for a start condition that starts a build based on a schedule. + + Full documentation: + + */ public struct CiScheduledStartCondition: Codable, Sendable { + /// The schedule information you configure for a workflow that starts a new build based on a schedule. public var schedule: Schedule? + /// The source branch name and custom patterns you configure for a workflow that starts a new build on a schedule. public var source: CiBranchPatterns? public init(schedule: Schedule? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiStartConditionFileMatcher.swift b/Sources/Bagbutik-Models/XcodeCloud/CiStartConditionFileMatcher.swift index cd8e885b6..be7b088c4 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiStartConditionFileMatcher.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiStartConditionFileMatcher.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CiStartConditionFileMatcher + The data structure that represents a Start Condition File Matchers resource. + + Full documentation: + + */ public struct CiStartConditionFileMatcher: Codable, Sendable { + /// The directory you configure for a custom start condition’s Files and Folders setting. public var directory: String? + /// The file extension you configure for a custom start condition’s Files and Folders setting. public var fileExtension: String? + /// The filename you configure for a custom start condition’s Files and Folders setting. public var fileName: String? public init(directory: String? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiTagPatterns.swift b/Sources/Bagbutik-Models/XcodeCloud/CiTagPatterns.swift index e465f0bdf..11f387e3c 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiTagPatterns.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiTagPatterns.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # CiTagPatterns + Case-sensitive patterns Xcode Cloud uses to determine if a change meets tag names you configure for a workflow’s start condition. + + Full documentation: + + */ public struct CiTagPatterns: Codable, Sendable { + /// ​A Boolean value that indicates whether a start condition’s settings apply to all tags. If `true`, the `patterns` attribute isn’t expected. If `false`, the `patterns` attribute is required. public var isAllMatch: Bool? + /// The list of case-sensitive patterns Xcode Cloud uses to determine if a change meets tag names you configure for a workflow’s start condition. public var patterns: [Patterns]? public init(isAllMatch: Bool? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiTagStartCondition.swift b/Sources/Bagbutik-Models/XcodeCloud/CiTagStartCondition.swift index b085cdce8..ac1823400 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiTagStartCondition.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiTagStartCondition.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CiTagStartCondition + Settings for a start condition that starts a build if a Git tag changes. + + Full documentation: + + */ public struct CiTagStartCondition: Codable, Sendable { + /// A Boolean value that indicates whether Xcode Cloud automatically cancels or skips builds. public var autoCancel: Bool? + /// Settings Xcode Cloud uses to determine whether a change to a tag should start a new build or not. public var filesAndFoldersRule: CiFilesAndFoldersRule? + /// The source branch name and custom patterns you configure for a workflow that starts a new build for changes to a Git tag. public var source: CiTagPatterns? public init(autoCancel: Bool? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiTestDestination.swift b/Sources/Bagbutik-Models/XcodeCloud/CiTestDestination.swift index 957cf3afd..356e6c6be 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiTestDestination.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiTestDestination.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiTestDestination + The test destination of a test action that Xcode Cloud performs. + + Full documentation: + + */ public struct CiTestDestination: Codable, Sendable { + /// A string that uniquely identifies the simulated device Xcode Cloud uses for a test action, for example, `com.apple.CoreSimulator.SimDeviceType.iPhone-12`. public var deviceTypeIdentifier: String? + /// The display name of the simulated device that Xcode Cloud uses for a test action, for example, iPhone 12. public var deviceTypeName: String? + /// A string that indicates whether a test destination is a simulated device or a Mac. public var kind: CiTestDestinationKind? + /// A string that identifies the simulated environment that Xcode Cloud uses for a test action. public var runtimeIdentifier: String? + /// The name of the operating system of the simulated environment that Xcode Cloud uses for a test action. public var runtimeName: String? public init(deviceTypeIdentifier: String? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiTestResult.swift b/Sources/Bagbutik-Models/XcodeCloud/CiTestResult.swift index 1e7de101e..c1f032e51 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiTestResult.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiTestResult.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # CiTestResult + The data structure that represents a Test Results resource. + + Full documentation: + + */ public struct CiTestResult: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Test Results resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "ciTestResults" } + /// The attributes that describe the Test Results resource. public var attributes: Attributes? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiTestResultResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiTestResultResponse.swift index 780177b50..c760b407c 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiTestResultResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiTestResultResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # CiTestResultResponse + A response that contains a single Test Results resource. + + Full documentation: + + */ public struct CiTestResultResponse: Codable, Sendable { + /// The resource data. public let data: CiTestResult + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: CiTestResult, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiTestResultsResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiTestResultsResponse.swift index 03c360c52..6416198d3 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiTestResultsResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiTestResultsResponse.swift @@ -1,11 +1,21 @@ import Bagbutik_Core import Foundation +/** + # CiTestResultsResponse + A response that contains a list of Test Results resources. + + Full documentation: + + */ public struct CiTestResultsResponse: Codable, Sendable, PagedResponse { public typealias Data = CiTestResult + /// The resource data. public let data: [CiTestResult] + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [CiTestResult], diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiWorkflow.swift b/Sources/Bagbutik-Models/XcodeCloud/CiWorkflow.swift index 8a5ddc457..701bff3b7 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiWorkflow.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiWorkflow.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiWorkflow + The data structure that represents a Workflows resource. + + Full documentation: + + */ public struct CiWorkflow: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Workflows resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "ciWorkflows" } + /// The attributes that describe the Workflows resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowCreateRequest.swift b/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowCreateRequest.swift index 218a2ae09..77bf67127 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowCreateRequest.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowCreateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # CiWorkflowCreateRequest + The request body you use to create a new Xcode Cloud workflow. + + Full documentation: + + */ public struct CiWorkflowCreateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowResponse.swift index 8d82a4226..2112d7afc 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CiWorkflowResponse + A response that contains a single Workflows resource. + + Full documentation: + + */ public struct CiWorkflowResponse: Codable, Sendable { + /// The resource data. public let data: CiWorkflow + /// The requested relationship data. public var included: [Included]? + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: CiWorkflow, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowUpdateRequest.swift b/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowUpdateRequest.swift index f44218b3f..268a84314 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowUpdateRequest.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowUpdateRequest.swift @@ -1,7 +1,15 @@ import Bagbutik_Core import Foundation +/** + # CiWorkflowUpdateRequest + The request body you use to update an Xcode Cloud workflow. + + Full documentation: + + */ public struct CiWorkflowUpdateRequest: Codable, Sendable, RequestBody { + /// The resource data. public let data: Data public init(data: Data) { diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowsResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowsResponse.swift index c9e41f8b1..702ae562a 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowsResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiWorkflowsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiWorkflowsResponse + A response that contains a list of Workflows resources. + + Full documentation: + + */ public struct CiWorkflowsResponse: Codable, Sendable, PagedResponse { public typealias Data = CiWorkflow + /// The resource data. public let data: [CiWorkflow] + /// The requested relationship data. public var included: [Included]? + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [CiWorkflow], diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersion.swift b/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersion.swift index 558c91e6c..984417172 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersion.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersion.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiXcodeVersion + The data structure that represents an Xcode Versions resource. + + Full documentation: + + */ public struct CiXcodeVersion: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies an Xcode Versions resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "ciXcodeVersions" } + /// The attributes that describe the Xcode Versions resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersionResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersionResponse.swift index de734c7d2..39c839163 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersionResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersionResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # CiXcodeVersionResponse + A response that contains a single Xcode Versions resource. + + Full documentation: + + */ public struct CiXcodeVersionResponse: Codable, Sendable { + /// The resource data. public let data: CiXcodeVersion + /// The requested relationship data. public var included: [CiMacOsVersion]? + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: CiXcodeVersion, diff --git a/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersionsResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersionsResponse.swift index 8a63916af..b7cdb8ee8 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersionsResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/CiXcodeVersionsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # CiXcodeVersionsResponse + A response that contains a list of Xcode Versions resources. + + Full documentation: + + */ public struct CiXcodeVersionsResponse: Codable, Sendable, PagedResponse { public typealias Data = CiXcodeVersion + /// The resource data. public let data: [CiXcodeVersion] + /// The requested relationship data. public var included: [CiMacOsVersion]? + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [CiXcodeVersion], diff --git a/Sources/Bagbutik-Models/XcodeCloud/FileLocation.swift b/Sources/Bagbutik-Models/XcodeCloud/FileLocation.swift index 372210422..e09351bd2 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/FileLocation.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/FileLocation.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # FileLocation + The data structure that represents a File Locations resource. + + Full documentation: + + */ public struct FileLocation: Codable, Sendable { + /// The line number of a file that contains code. public var lineNumber: Int? + /// The path to the file that caused an issue. public var path: String? public init(lineNumber: Int? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmGitReference.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmGitReference.swift index c1b1c8e19..e050fdbdc 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmGitReference.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmGitReference.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # ScmGitReference + The data structure that represents a Git References resource. + + Full documentation: + + */ public struct ScmGitReference: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Git References resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "scmGitReferences" } + /// The attributes that describe the Git References resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmGitReferenceResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmGitReferenceResponse.swift index dea80b16e..041ee5b33 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmGitReferenceResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmGitReferenceResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # ScmGitReferenceResponse + A response that contains a single Git References resource. + + Full documentation: + + */ public struct ScmGitReferenceResponse: Codable, Sendable { + /// The resource data. public let data: ScmGitReference + /// The requested relationship data. public var included: [ScmRepository]? + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: ScmGitReference, diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmGitReferencesResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmGitReferencesResponse.swift index 3370f76e2..fe2e0e208 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmGitReferencesResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmGitReferencesResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # ScmGitReferencesResponse + A response that contains a list of Git References resources. + + Full documentation: + + */ public struct ScmGitReferencesResponse: Codable, Sendable, PagedResponse { public typealias Data = ScmGitReference + /// The resource data. public let data: [ScmGitReference] + /// The requested relationship data. public var included: [ScmRepository]? + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [ScmGitReference], diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmProvider.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmProvider.swift index 8c8d92e51..40700aecd 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmProvider.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmProvider.swift @@ -1,10 +1,21 @@ import Bagbutik_Core import Foundation +/** + # ScmProvider + The data structure that represents a Providers resource. + + Full documentation: + + */ public struct ScmProvider: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Providers resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "scmProviders" } + /// The attributes that describe the Providers resource. public var attributes: Attributes? public var relationships: Relationships? diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmProviderResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmProviderResponse.swift index 66073337d..df8de5c0a 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmProviderResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmProviderResponse.swift @@ -1,8 +1,17 @@ import Bagbutik_Core import Foundation +/** + # ScmProviderResponse + A response that contains a single Providers resource. + + Full documentation: + + */ public struct ScmProviderResponse: Codable, Sendable { + /// The resource data. public let data: ScmProvider + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: ScmProvider, diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmProviderType.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmProviderType.swift index e8dc7ce52..21cdc1367 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmProviderType.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmProviderType.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # ScmProviderType + The source code management provider’s type. + + Full documentation: + + */ public struct ScmProviderType: Codable, Sendable { + /// The source code management provider’s display name; for example, `Bitbucket Server`. public var displayName: String? + /// A Boolean value that indicates whether it’s a self-hosted source code management provider. public var isOnPremise: Bool? + /// A string that represents the kind of a Providers resource. public var kind: Kind? public init(displayName: String? = nil, diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmProvidersResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmProvidersResponse.swift index e74ba8370..998c5ba23 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmProvidersResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmProvidersResponse.swift @@ -1,11 +1,21 @@ import Bagbutik_Core import Foundation +/** + # ScmProvidersResponse + A response that contains a list of Providers resources. + + Full documentation: + + */ public struct ScmProvidersResponse: Codable, Sendable, PagedResponse { public typealias Data = ScmProvider + /// The resource data. public let data: [ScmProvider] + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [ScmProvider], diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequest.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequest.swift index 52d522c9f..199ed3fbf 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequest.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequest.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # ScmPullRequest + The data structure that represents a Pull Requests resource. + + Full documentation: + + */ public struct ScmPullRequest: Codable, Sendable, Identifiable, RequestBody { + /// The opaque resource ID that uniquely identifies a Pull Request resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "scmPullRequests" } + /// The attributes that describe the Pull Requests resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequestResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequestResponse.swift index 477cd92ba..458896ae9 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequestResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequestResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # ScmPullRequestResponse + A response that contains a single Pull Requests resource. + + Full documentation: + + */ public struct ScmPullRequestResponse: Codable, Sendable { + /// The resource data. public let data: ScmPullRequest + /// The requested relationship data. public var included: [ScmRepository]? + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: ScmPullRequest, diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequestsResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequestsResponse.swift index 6cef898b3..55c3d2eae 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequestsResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmPullRequestsResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # ScmPullRequestsResponse + A response that contains a list of Pull Requests resources. + + Full documentation: + + */ public struct ScmPullRequestsResponse: Codable, Sendable, PagedResponse { public typealias Data = ScmPullRequest + /// The resource data. public let data: [ScmPullRequest] + /// The requested relationship data. public var included: [ScmRepository]? + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [ScmPullRequest], diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmRepositoriesResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmRepositoriesResponse.swift index c040c5ad0..aa4eda458 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmRepositoriesResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmRepositoriesResponse.swift @@ -1,12 +1,23 @@ import Bagbutik_Core import Foundation +/** + # ScmRepositoriesResponse + A response that contains a list of Repositories resources. + + Full documentation: + + */ public struct ScmRepositoriesResponse: Codable, Sendable, PagedResponse { public typealias Data = ScmRepository + /// The resource data. public let data: [ScmRepository] + /// The requested relationship data. public var included: [Included]? + /// The navigational links that include the self-link. public let links: PagedDocumentLinks + /// The paging information. public var meta: PagingInformation? public init(data: [ScmRepository], diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmRepository.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmRepository.swift index 3fc95b0ae..584537c9a 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmRepository.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmRepository.swift @@ -1,11 +1,23 @@ import Bagbutik_Core import Foundation +/** + # ScmRepository + The data structure that represents a Repositories resource. + + Full documentation: + + */ public struct ScmRepository: Codable, Sendable, Identifiable { + /// The opaque resource ID that uniquely identifies a Repositories resource. public let id: String + /// The navigational links that include the self-link. public var links: ResourceLinks? + /// The resource type. public var type: String { "scmRepositories" } + /// The attributes that describe the Repositories resource. public var attributes: Attributes? + /// The navigational links to related data and included resource types and IDs. public var relationships: Relationships? public init(id: String, diff --git a/Sources/Bagbutik-Models/XcodeCloud/ScmRepositoryResponse.swift b/Sources/Bagbutik-Models/XcodeCloud/ScmRepositoryResponse.swift index 278b952ee..4255c26a8 100644 --- a/Sources/Bagbutik-Models/XcodeCloud/ScmRepositoryResponse.swift +++ b/Sources/Bagbutik-Models/XcodeCloud/ScmRepositoryResponse.swift @@ -1,9 +1,19 @@ import Bagbutik_Core import Foundation +/** + # ScmRepositoryResponse + A response that contains a single Repositories resource. + + Full documentation: + + */ public struct ScmRepositoryResponse: Codable, Sendable { + /// The resource data. public let data: ScmRepository + /// The requested relationship data. public var included: [Included]? + /// The navigational links that include the self-link. public let links: DocumentLinks public init(data: ScmRepository, diff --git a/Sources/BagbutikDocsCollector/DocsLoader.swift b/Sources/BagbutikDocsCollector/DocsLoader.swift index 699959493..d5f784211 100644 --- a/Sources/BagbutikDocsCollector/DocsLoader.swift +++ b/Sources/BagbutikDocsCollector/DocsLoader.swift @@ -25,7 +25,11 @@ public actor DocsLoader { self.loadFile = loadFile self.operationDocumentationById = operationDocumentationById self.identifierBySchemaName = identifierBySchemaName - self.schemaDocumentationById = schemaDocumentationById + self.schemaDocumentationById = schemaDocumentationById.map { schemaDocumentationById in + Dictionary(uniqueKeysWithValues: schemaDocumentationById.map { key, value in + (key.lowercased(), value) + }) + } } public func loadDocs(documentationDirURL: URL) async throws { @@ -33,12 +37,15 @@ public actor DocsLoader { let identifierBySchemaNameData = try await loadFile(documentationDirURL.appendingPathComponent(DocsFilename.schemaMapping.filename)) let schemaDocumentationByIdData = try await loadFile(documentationDirURL.appendingPathComponent(DocsFilename.schemaDocumentation.filename)) let jsonDecoder = JSONDecoder() - self.operationDocumentationById = try jsonDecoder.decode([String: Documentation].self, from: operationDocumentationByIdData).mapValues { documentation in + operationDocumentationById = try jsonDecoder.decode([String: Documentation].self, from: operationDocumentationByIdData).mapValues { documentation in guard case .operation(let operationDocumentation) = documentation else { throw DocsLoaderError.wrongTypeOfDocumentation } return operationDocumentation } - self.identifierBySchemaName = try jsonDecoder.decode([String: String].self, from: identifierBySchemaNameData) - self.schemaDocumentationById = try jsonDecoder.decode([String: Documentation].self, from: schemaDocumentationByIdData) + identifierBySchemaName = try jsonDecoder.decode([String: String].self, from: identifierBySchemaNameData) + let loadedSchemaDocumentationById = try jsonDecoder.decode([String: Documentation].self, from: schemaDocumentationByIdData) + schemaDocumentationById = Dictionary(uniqueKeysWithValues: loadedSchemaDocumentationById.map { key, value in + (key.lowercased(), value) + }) } public func applyManualDocumentation() throws { @@ -89,7 +96,7 @@ public actor DocsLoader { let schemaDocumentationById else { throw DocsLoaderError.documentationNotLoaded } - guard let identifier = identifierBySchemaName[schemaName], + guard let identifier = identifierBySchemaName[schemaName]?.lowercased(), let documentation = schemaDocumentationById[identifier] else { return nil } @@ -98,7 +105,7 @@ public actor DocsLoader { public func resolveDocumentationForSchema(withDocsUrl docsUrl: String) throws -> Documentation? { guard let schemaDocumentationById else { throw DocsLoaderError.documentationNotLoaded } - let identifier = self.createDocumentationId(fromUrl: docsUrl) + let identifier = createDocumentationId(fromUrl: docsUrl) guard let documentation = schemaDocumentationById[identifier] else { return nil } return documentation } diff --git a/Tests/BagbutikDocsCollectorTests/DocsLoaderTests.swift b/Tests/BagbutikDocsCollectorTests/DocsLoaderTests.swift index aedd3fa20..789e7181a 100644 --- a/Tests/BagbutikDocsCollectorTests/DocsLoaderTests.swift +++ b/Tests/BagbutikDocsCollectorTests/DocsLoaderTests.swift @@ -16,7 +16,7 @@ class DocsLoaderTests: XCTestCase { let schemaDocumentationById = await docsLoader.schemaDocumentationById XCTAssertEqual(operationDocumentationById, [Self.operationDocumentation.id: Self.operationDocumentation]) XCTAssertEqual(identifierBySchemaName, ["User": "doc://com.apple.appstoreconnectapi/documentation/AppStoreConnectAPI/user"]) - XCTAssertEqual(schemaDocumentationById, [Self.schemaDocumentation.id: Documentation.object(Self.schemaDocumentation)]) + XCTAssertEqual(schemaDocumentationById, [Self.schemaDocumentation.id.lowercased(): Documentation.object(Self.schemaDocumentation)]) } func testLoadDocs_ErrorLoading() async throws { @@ -204,7 +204,7 @@ class DocsLoaderTests: XCTestCase { let docsLoader = DocsLoader(loadFile: { try Self.loadFile($0)} ) try await docsLoader.loadDocs(documentationDirURL: validDocumentationDirURL) // When - let documentation = try await docsLoader.resolveDocumentationForSchema(withDocsUrl: "doc://com.apple.appstoreconnectapi/documentation/AppStoreConnectAPI/user") + let documentation = try await docsLoader.resolveDocumentationForSchema(withDocsUrl: "doc://com.apple.appstoreconnectapi/documentation/AppStoreConnectAPI/user".lowercased()) // Then XCTAssertEqual(documentation, Documentation.object(Self.schemaDocumentation)) } @@ -234,7 +234,7 @@ class DocsLoaderTests: XCTestCase { let docsLoader = DocsLoader(loadFile: { try Self.loadFile($0)} ) try await docsLoader.loadDocs(documentationDirURL: validDocumentationDirURL) // When - let documentation = try await docsLoader.resolveDocumentationForSchema(withId: "doc://com.apple.appstoreconnectapi/documentation/AppStoreConnectAPI/user") + let documentation = try await docsLoader.resolveDocumentationForSchema(withId: "doc://com.apple.appstoreconnectapi/documentation/AppStoreConnectAPI/user".lowercased()) // Then XCTAssertEqual(documentation, Documentation.object(Self.schemaDocumentation)) }