-
-
Notifications
You must be signed in to change notification settings - Fork 22
/
apps_metadata_screenshot_sets.go
239 lines (218 loc) · 12.8 KB
/
apps_metadata_screenshot_sets.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
package asc
import (
"context"
"fmt"
)
// ScreenshotDisplayType defines model for ScreenshotDisplayType.
//
// https://developer.apple.com/documentation/appstoreconnectapi/screenshotdisplaytype
type ScreenshotDisplayType string
const (
// ScreenshotDisplayTypeAppAppleTV is a screenshot display type for AppAppleTV.
ScreenshotDisplayTypeAppAppleTV ScreenshotDisplayType = "APP_APPLE_TV"
// ScreenshotDisplayTypeAppDesktop is a screenshot display type for AppDesktop.
ScreenshotDisplayTypeAppDesktop ScreenshotDisplayType = "APP_DESKTOP"
// ScreenshotDisplayTypeAppiPad105 is a screenshot display type for AppiPad105.
ScreenshotDisplayTypeAppiPad105 ScreenshotDisplayType = "APP_IPAD_105"
// ScreenshotDisplayTypeAppiPad97 is a screenshot display type for AppiPad97.
ScreenshotDisplayTypeAppiPad97 ScreenshotDisplayType = "APP_IPAD_97"
// ScreenshotDisplayTypeAppiPadPro129 is a screenshot display type for AppiPadPro129.
ScreenshotDisplayTypeAppiPadPro129 ScreenshotDisplayType = "APP_IPAD_PRO_129"
// ScreenshotDisplayTypeAppiPadPro3Gen11 is a screenshot display type for AppiPadPro3Gen11.
ScreenshotDisplayTypeAppiPadPro3Gen11 ScreenshotDisplayType = "APP_IPAD_PRO_3GEN_11"
// ScreenshotDisplayTypeAppiPadPro3Gen129 is a screenshot display type for AppiPadPro3Gen129.
ScreenshotDisplayTypeAppiPadPro3Gen129 ScreenshotDisplayType = "APP_IPAD_PRO_3GEN_129"
// ScreenshotDisplayTypeAppiPhone35 is a screenshot display type for AppiPhone35.
ScreenshotDisplayTypeAppiPhone35 ScreenshotDisplayType = "APP_IPHONE_35"
// ScreenshotDisplayTypeAppiPhone40 is a screenshot display type for AppiPhone40.
ScreenshotDisplayTypeAppiPhone40 ScreenshotDisplayType = "APP_IPHONE_40"
// ScreenshotDisplayTypeAppiPhone47 is a screenshot display type for AppiPhone47.
ScreenshotDisplayTypeAppiPhone47 ScreenshotDisplayType = "APP_IPHONE_47"
// ScreenshotDisplayTypeAppiPhone55 is a screenshot display type for AppiPhone55.
ScreenshotDisplayTypeAppiPhone55 ScreenshotDisplayType = "APP_IPHONE_55"
// ScreenshotDisplayTypeAppiPhone58 is a screenshot display type for AppiPhone58.
ScreenshotDisplayTypeAppiPhone58 ScreenshotDisplayType = "APP_IPHONE_58"
// ScreenshotDisplayTypeAppiPhone65 is a screenshot display type for AppiPhone65.
ScreenshotDisplayTypeAppiPhone65 ScreenshotDisplayType = "APP_IPHONE_65"
// ScreenshotDisplayTypeAppWatchSeries3 is a screenshot display type for AppWatchSeries3.
ScreenshotDisplayTypeAppWatchSeries3 ScreenshotDisplayType = "APP_WATCH_SERIES_3"
// ScreenshotDisplayTypeAppWatchSeries4 is a screenshot display type for AppWatchSeries4.
ScreenshotDisplayTypeAppWatchSeries4 ScreenshotDisplayType = "APP_WATCH_SERIES_4"
// ScreenshotDisplayTypeiMessageAppIPad105 is a screenshot display type for iMessageAppIPad105.
ScreenshotDisplayTypeiMessageAppIPad105 ScreenshotDisplayType = "IMESSAGE_APP_IPAD_105"
// ScreenshotDisplayTypeiMessageAppIPad97 is a screenshot display type for iMessageAppIPad97.
ScreenshotDisplayTypeiMessageAppIPad97 ScreenshotDisplayType = "IMESSAGE_APP_IPAD_97"
// ScreenshotDisplayTypeiMessageAppIPadPro129 is a screenshot display type for iMessageAppIPadPro129.
ScreenshotDisplayTypeiMessageAppIPadPro129 ScreenshotDisplayType = "IMESSAGE_APP_IPAD_PRO_129"
// ScreenshotDisplayTypeiMessageAppIPadPro3Gen11 is a screenshot display type for iMessageAppIPadPro3Gen11.
ScreenshotDisplayTypeiMessageAppIPadPro3Gen11 ScreenshotDisplayType = "IMESSAGE_APP_IPAD_PRO_3GEN_11"
// ScreenshotDisplayTypeiMessageAppIPadPro3Gen129 is a screenshot display type for iMessageAppIPadPro3Gen129.
ScreenshotDisplayTypeiMessageAppIPadPro3Gen129 ScreenshotDisplayType = "IMESSAGE_APP_IPAD_PRO_3GEN_129"
// ScreenshotDisplayTypeiMessageAppIPhone40 is a screenshot display type for iMessageAppIPhone40.
ScreenshotDisplayTypeiMessageAppIPhone40 ScreenshotDisplayType = "IMESSAGE_APP_IPHONE_40"
// ScreenshotDisplayTypeiMessageAppIPhone47 is a screenshot display type for iMessageAppIPhone47.
ScreenshotDisplayTypeiMessageAppIPhone47 ScreenshotDisplayType = "IMESSAGE_APP_IPHONE_47"
// ScreenshotDisplayTypeiMessageAppIPhone55 is a screenshot display type for iMessageAppIPhone55.
ScreenshotDisplayTypeiMessageAppIPhone55 ScreenshotDisplayType = "IMESSAGE_APP_IPHONE_55"
// ScreenshotDisplayTypeiMessageAppIPhone58 is a screenshot display type for iMessageAppIPhone58.
ScreenshotDisplayTypeiMessageAppIPhone58 ScreenshotDisplayType = "IMESSAGE_APP_IPHONE_58"
// ScreenshotDisplayTypeiMessageAppIPhone65 is a screenshot display type for iMessageAppIPhone65.
ScreenshotDisplayTypeiMessageAppIPhone65 ScreenshotDisplayType = "IMESSAGE_APP_IPHONE_65"
)
// AppScreenshotSet defines model for AppScreenshotSet.
//
// https://developer.apple.com/documentation/appstoreconnectapi/appscreenshotset
type AppScreenshotSet struct {
Attributes *AppScreenshotSetAttributes `json:"attributes,omitempty"`
ID string `json:"id"`
Links ResourceLinks `json:"links"`
Relationships *AppScreenshotSetRelationships `json:"relationships,omitempty"`
Type string `json:"type"`
}
// AppScreenshotSetAttributes defines model for AppScreenshotSet.Attributes
//
// https://developer.apple.com/documentation/appstoreconnectapi/appscreenshotset/attributes
type AppScreenshotSetAttributes struct {
ScreenshotDisplayType *ScreenshotDisplayType `json:"screenshotDisplayType,omitempty"`
}
// AppScreenshotSetRelationships defines model for AppScreenshotSet.Relationships
//
// https://developer.apple.com/documentation/appstoreconnectapi/appscreenshotset/relationships
type AppScreenshotSetRelationships struct {
AppScreenshots *PagedRelationship `json:"appScreenshots,omitempty"`
AppStoreVersionLocalization *Relationship `json:"appStoreVersionLocalization,omitempty"`
}
// appScreenshotSetCreateRequest defines model for AppScreenshotSetCreateRequest.
//
// https://developer.apple.com/documentation/appstoreconnectapi/appscreenshotsetcreaterequest/data
type appScreenshotSetCreateRequest struct {
Attributes appScreenshotSetCreateRequestAttributes `json:"attributes"`
Relationships appScreenshotSetCreateRequestRelationships `json:"relationships"`
Type string `json:"type"`
}
// appScreenshotSetCreateRequestAttributes are attributes for AppScreenshotSetCreateRequest
//
// https://developer.apple.com/documentation/appstoreconnectapi/appscreenshotsetcreaterequest/data/attributes
type appScreenshotSetCreateRequestAttributes struct {
ScreenshotDisplayType ScreenshotDisplayType `json:"screenshotDisplayType"`
}
// appScreenshotSetCreateRequestRelationships are relationships for AppScreenshotSetCreateRequest
//
// https://developer.apple.com/documentation/appstoreconnectapi/appscreenshotsetcreaterequest/data/relationships
type appScreenshotSetCreateRequestRelationships struct {
AppStoreVersionLocalization relationshipDeclaration `json:"appStoreVersionLocalization"`
}
// AppScreenshotSetResponse defines model for AppScreenshotSetResponse.
//
// https://developer.apple.com/documentation/appstoreconnectapi/appscreenshotsetresponse
type AppScreenshotSetResponse struct {
Data AppScreenshotSet `json:"data"`
Included []AppScreenshot `json:"included,omitempty"`
Links DocumentLinks `json:"links"`
}
// AppScreenshotSetsResponse defines model for AppScreenshotSetsResponse.
//
// https://developer.apple.com/documentation/appstoreconnectapi/appscreenshotsetsresponse
type AppScreenshotSetsResponse struct {
Data []AppScreenshotSet `json:"data"`
Included []AppScreenshot `json:"included,omitempty"`
Links PagedDocumentLinks `json:"links"`
Meta *PagingInformation `json:"meta,omitempty"`
}
// AppScreenshotSetAppScreenshotsLinkagesResponse defines model for AppScreenshotSetAppScreenshotsLinkagesResponse.
//
// https://developer.apple.com/documentation/appstoreconnectapi/appscreenshotsetappscreenshotslinkagesresponse
type AppScreenshotSetAppScreenshotsLinkagesResponse struct {
Data []RelationshipData `json:"data"`
Links PagedDocumentLinks `json:"links"`
Meta *PagingInformation `json:"meta,omitempty"`
}
// GetAppScreenshotSetQuery are query options for GetAppScreenshotSet
//
// https://developer.apple.com/documentation/appstoreconnectapi/read_app_screenshot_set_information
type GetAppScreenshotSetQuery struct {
FieldsAppScreenshots []string `url:"fields[appScreenshots],omitempty"`
FieldsAppScreenshotSets []string `url:"fields[appScreenshotSets],omitempty"`
Include []string `url:"include,omitempty"`
LimitAppScreenshots int `url:"limit[appScreenshots],omitempty"`
}
// ListAppScreenshotsForSetQuery are query options for ListAppScreenshotsForSet
//
// https://developer.apple.com/documentation/appstoreconnectapi/list_all_app_screenshots_for_an_app_screenshot_set
type ListAppScreenshotsForSetQuery struct {
FieldsAppScreenshotSets []string `url:"fields[appScreenshotSets],omitempty"`
FieldsAppScreenshots []string `url:"fields[appScreenshots],omitempty"`
Limit int `url:"limit,omitempty"`
Include []string `url:"include,omitempty"`
Cursor string `url:"cursor,omitempty"`
}
// ListAppScreenshotIDsForSetQuery are query options for ListAppScreenshotIDsForSet
//
// https://developer.apple.com/documentation/appstoreconnectapi/get_all_app_screenshot_ids_for_an_app_screenshot_set
type ListAppScreenshotIDsForSetQuery struct {
Limit int `url:"limit,omitempty"`
}
// GetAppScreenshotSet gets an app screenshot set including its display target, language, and the screenshot it contains.
//
// https://developer.apple.com/documentation/appstoreconnectapi/read_app_screenshot_set_information
func (s *AppsService) GetAppScreenshotSet(ctx context.Context, id string, params *GetAppScreenshotSetQuery) (*AppScreenshotSetResponse, *Response, error) {
url := fmt.Sprintf("appScreenshotSets/%s", id)
res := new(AppScreenshotSetResponse)
resp, err := s.client.get(ctx, url, params, res)
return res, resp, err
}
// CreateAppScreenshotSet adds a new screenshot set to an App Store version localization for a specific screenshot type and display size.
//
// https://developer.apple.com/documentation/appstoreconnectapi/create_an_app_screenshot_set
func (s *AppsService) CreateAppScreenshotSet(ctx context.Context, screenshotDisplayType ScreenshotDisplayType, appStoreVersionLocalizationID string) (*AppScreenshotSetResponse, *Response, error) {
req := appScreenshotSetCreateRequest{
Attributes: appScreenshotSetCreateRequestAttributes{
ScreenshotDisplayType: screenshotDisplayType,
},
Relationships: appScreenshotSetCreateRequestRelationships{
AppStoreVersionLocalization: relationshipDeclaration{
Data: RelationshipData{
ID: appStoreVersionLocalizationID,
Type: "appStoreVersionLocalizations",
},
},
},
Type: "appScreenshotSets",
}
res := new(AppScreenshotSetResponse)
resp, err := s.client.post(ctx, "appScreenshotSets", newRequestBody(req), res)
return res, resp, err
}
// DeleteAppScreenshotSet deletes an app screenshot set and all of its screenshots.
//
// https://developer.apple.com/documentation/appstoreconnectapi/delete_an_app_screenshot_set
func (s *AppsService) DeleteAppScreenshotSet(ctx context.Context, id string) (*Response, error) {
url := fmt.Sprintf("appScreenshotSets/%s", id)
return s.client.delete(ctx, url, nil)
}
// ListAppScreenshotsForSet lists all ordered screenshots in a screenshot set.
//
// https://developer.apple.com/documentation/appstoreconnectapi/list_all_app_screenshots_for_an_app_screenshot_set
func (s *AppsService) ListAppScreenshotsForSet(ctx context.Context, id string, params *ListAppScreenshotsForSetQuery) (*AppScreenshotsResponse, *Response, error) {
url := fmt.Sprintf("appScreenshotSets/%s/appScreenshots", id)
res := new(AppScreenshotsResponse)
resp, err := s.client.get(ctx, url, params, res)
return res, resp, err
}
// ListAppScreenshotIDsForSet gets the ordered screenshot IDs in a screenshot set.
//
// https://developer.apple.com/documentation/appstoreconnectapi/get_all_app_screenshot_ids_for_an_app_screenshot_set
func (s *AppsService) ListAppScreenshotIDsForSet(ctx context.Context, id string, params *ListAppScreenshotIDsForSetQuery) (*AppScreenshotSetAppScreenshotsLinkagesResponse, *Response, error) {
url := fmt.Sprintf("appScreenshotSets/%s/relationships/appScreenshots", id)
res := new(AppScreenshotSetAppScreenshotsLinkagesResponse)
resp, err := s.client.get(ctx, url, params, res)
return res, resp, err
}
// ReplaceAppScreenshotsForSet changes the order of the screenshots in a screenshot set.
//
// https://developer.apple.com/documentation/appstoreconnectapi/replace_all_app_screenshots_for_an_app_screenshot_set
func (s *AppsService) ReplaceAppScreenshotsForSet(ctx context.Context, id string, appScreenshotIDs []string) (*Response, error) {
linkages := newPagedRelationshipDeclaration(appScreenshotIDs, "appScreenshots")
url := fmt.Sprintf("appScreenshotSets/%s/relationships/appScreenshots", id)
return s.client.patch(ctx, url, newRequestBody(linkages), nil)
}