Module: Spaceship::ConnectAPI::Tunes::API

Defined in:
spaceship/lib/spaceship/connect_api/tunes/tunes.rb

Instance Method Summary collapse

Instance Method Details

#delete_app_data_usage(app_data_usage_id: nil) ⇒ Object



273
274
275
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 273

def delete_app_data_usage(app_data_usage_id: nil)
  tunes_request_client.delete("appDataUsages/#{app_data_usage_id}")
end

#delete_app_info(app_info_id: nil) ⇒ Object



688
689
690
691
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 688

def delete_app_info(app_info_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("appInfos/#{app_info_id}", params)
end

#delete_app_preview(app_preview_id: nil) ⇒ Object



358
359
360
361
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 358

def delete_app_preview(app_preview_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("appPreviews/#{app_preview_id}", params)
end

#delete_app_preview_set(app_preview_set_id: nil) ⇒ Object



396
397
398
399
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 396

def delete_app_preview_set(app_preview_set_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("appPreviewSets/#{app_preview_set_id}", params)
end

#delete_app_screenshot(app_screenshot_id: nil) ⇒ Object



580
581
582
583
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 580

def delete_app_screenshot(app_screenshot_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("appScreenshots/#{app_screenshot_id}", params)
end

#delete_app_screenshot_set(app_screenshot_set_id: nil) ⇒ Object



535
536
537
538
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 535

def delete_app_screenshot_set(app_screenshot_set_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("appScreenshotSets/#{app_screenshot_set_id}", params)
end

#delete_app_store_review_attachment(app_store_review_attachment_id: nil) ⇒ Object



482
483
484
485
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 482

def delete_app_store_review_attachment(app_store_review_attachment_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("appStoreReviewAttachments/#{app_store_review_attachment_id}", params)
end

#delete_app_store_version_localization(app_store_version_localization_id: nil) ⇒ Object



818
819
820
821
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 818

def delete_app_store_version_localization(app_store_version_localization_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("appStoreVersionLocalizations/#{app_store_version_localization_id}", params)
end

#delete_app_store_version_phased_release(app_store_version_phased_release_id: nil) ⇒ Object



863
864
865
866
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 863

def delete_app_store_version_phased_release(app_store_version_phased_release_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("appStoreVersionPhasedReleases/#{app_store_version_phased_release_id}", params)
end

#delete_app_store_version_submission(app_store_version_submission_id: nil) ⇒ Object



996
997
998
999
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 996

def delete_app_store_version_submission(app_store_version_submission_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("appStoreVersionSubmissions/#{app_store_version_submission_id}", params)
end

#delete_custom_app_organization(custom_app_organization_id: nil) ⇒ Object



1089
1090
1091
1092
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1089

def delete_custom_app_organization(custom_app_organization_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("customAppOrganizations/#{custom_app_organization_id}", params)
end

#delete_custom_app_user(custom_app_user_id: nil) ⇒ Object



1053
1054
1055
1056
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1053

def delete_custom_app_user(custom_app_user_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("customAppUsers/#{custom_app_user_id}", params)
end

#delete_idfa_declaration(idfa_declaration_id: nil) ⇒ Object



1134
1135
1136
1137
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1134

def delete_idfa_declaration(idfa_declaration_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("idfaDeclarations/#{idfa_declaration_id}", params)
end

#delete_reset_ratings_request(reset_ratings_request_id: nil) ⇒ Object



964
965
966
967
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 964

def delete_reset_ratings_request(reset_ratings_request_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("resetRatingsRequests/#{reset_ratings_request_id}", params)
end

#delete_sandbox_tester(sandbox_tester_id: nil) ⇒ Object



1242
1243
1244
1245
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1242

def delete_sandbox_tester(sandbox_tester_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.delete("sandboxTesters/#{sandbox_tester_id}", params)
end

#get_age_rating_declaration(app_info_id: nil, app_store_version_id: nil) ⇒ Object

ageRatingDeclarations



20
21
22
23
24
25
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 20

def get_age_rating_declaration(app_info_id: nil, app_store_version_id: nil)
  raise "Keyword 'app_store_version_id' is deprecated and 'app_info_id' is required" if app_store_version_id || app_info_id.nil?

  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.get("appInfos/#{app_info_id}/ageRatingDeclaration", params)
end

#get_app_data_usage_categories(filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appDataUsageCategory



281
282
283
284
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 281

def get_app_data_usage_categories(filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appDataUsageCategories", params)
end

#get_app_data_usage_purposes(filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appDataUsagePurpose



290
291
292
293
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 290

def get_app_data_usage_purposes(filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appDataUsagePurposes", params)
end

#get_app_data_usages(app_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appDataUsage



219
220
221
222
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 219

def get_app_data_usages(app_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("apps/#{app_id}/dataUsages", params)
end

#get_app_data_usages_publish_state(app_id: nil) ⇒ Object

appDataUsagesPublishState



299
300
301
302
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 299

def get_app_data_usages_publish_state(app_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.get("apps/#{app_id}/dataUsagePublishState", params)
end

#get_app_info_localizations(app_info_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appInfoLocalizations



697
698
699
700
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 697

def get_app_info_localizations(app_info_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appInfos/#{app_info_id}/appInfoLocalizations", params)
end

#get_app_infos(app_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appInfos



589
590
591
592
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 589

def get_app_infos(app_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("apps/#{app_id}/appInfos", params)
end

#get_app_preview(app_preview_id: nil) ⇒ Object

appPreview



322
323
324
325
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 322

def get_app_preview(app_preview_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.get("appPreviews/#{app_preview_id}", params)
end

#get_app_preview_set(app_preview_set_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object



372
373
374
375
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 372

def get_app_preview_set(app_preview_set_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appPreviewSets/#{app_preview_set_id}", params)
end

#get_app_preview_sets(filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appPreviewSets



367
368
369
370
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 367

def get_app_preview_sets(filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appPreviewSets", params)
end

#get_app_price(app_price_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object



434
435
436
437
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 434

def get_app_price(app_price_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appPrices/#{app_price_id}", params)
end

#get_app_price_points(filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appPricePoints



442
443
444
445
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 442

def get_app_price_points(filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appPricePoints", params)
end

#get_app_prices(app_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appPrices



429
430
431
432
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 429

def get_app_prices(app_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appPrices", params)
end

#get_app_screenshot(app_screenshot_id: nil) ⇒ Object

appScreenshots



544
545
546
547
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 544

def get_app_screenshot(app_screenshot_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.get("appScreenshots/#{app_screenshot_id}", params)
end

#get_app_screenshot_set(app_screenshot_set_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object



496
497
498
499
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 496

def get_app_screenshot_set(app_screenshot_set_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appScreenshotSets/#{app_screenshot_set_id}", params)
end

#get_app_screenshot_sets(app_store_version_localization_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appScreenshotSets



491
492
493
494
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 491

def get_app_screenshot_sets(app_store_version_localization_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appStoreVersionLocalizations/#{app_store_version_localization_id}/appScreenshotSets", params)
end

#get_app_store_review_detail(app_store_version_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appStoreReviewDetails



737
738
739
740
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 737

def get_app_store_review_detail(app_store_version_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appStoreVersions/#{app_store_version_id}/appStoreReviewDetail", params)
end

#get_app_store_version(app_store_version_id: nil, includes: nil) ⇒ Object



877
878
879
880
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 877

def get_app_store_version(app_store_version_id: nil, includes: nil)
  params = tunes_request_client.build_params(filter: nil, includes: includes, limit: nil, sort: nil)
  tunes_request_client.get("appStoreVersions/#{app_store_version_id}", params)
end

#get_app_store_version_localization(app_store_version_localization_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object



782
783
784
785
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 782

def get_app_store_version_localization(app_store_version_localization_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.get("appStoreVersionLocalizations/#{app_store_version_localization_id}", params)
end

#get_app_store_version_localizations(app_store_version_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appStoreVersionLocalizations



777
778
779
780
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 777

def get_app_store_version_localizations(app_store_version_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("appStoreVersions/#{app_store_version_id}/appStoreVersionLocalizations", params)
end

#get_app_store_version_phased_release(app_store_version_id: nil) ⇒ Object

appStoreVersionPhasedReleases



827
828
829
830
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 827

def get_app_store_version_phased_release(app_store_version_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.get("appStoreVersions/#{app_store_version_id}/appStoreVersionPhasedRelease", params)
end

#get_app_store_version_submission(app_store_version_id: nil) ⇒ Object

appStoreVersionSubmissions



973
974
975
976
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 973

def get_app_store_version_submission(app_store_version_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.get("appStoreVersions/#{app_store_version_id}/appStoreVersionSubmission", params)
end

#get_app_store_versions(app_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

appStoreVersions



872
873
874
875
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 872

def get_app_store_versions(app_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("apps/#{app_id}/appStoreVersions", params)
end

#get_available_territories(app_id: nil, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

availableTerritories



420
421
422
423
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 420

def get_available_territories(app_id: nil, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("apps/#{app_id}/availableTerritories", params)
end

#get_custom_app_organization(app_id: nil, filter: nil, includes: nil, limit: nil, sort: nil) ⇒ Object

customOrganizationUsers



1062
1063
1064
1065
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1062

def get_custom_app_organization(app_id: nil, filter: nil, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("apps/#{app_id}/customAppOrganizations", params)
end

#get_custom_app_users(app_id: nil, filter: nil, includes: nil, limit: nil, sort: nil) ⇒ Object

customAppUsers



1027
1028
1029
1030
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1027

def get_custom_app_users(app_id: nil, filter: nil, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("apps/#{app_id}/customAppUsers", params)
end

#get_idfa_declaration(app_store_version_id: nil) ⇒ Object

idfaDeclarations



1098
1099
1100
1101
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1098

def get_idfa_declaration(app_store_version_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.get("appStoreVersions/#{app_store_version_id}/idfaDeclaration", params)
end

#get_reset_ratings_request(app_store_version_id: nil) ⇒ Object

appStoreVersionPhasedReleases



941
942
943
944
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 941

def get_reset_ratings_request(app_store_version_id: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.get("appStoreVersions/#{app_store_version_id}/resetRatingsRequest", params)
end

#get_resolution_center_messages(thread_id:, filter: {}, includes: nil) ⇒ Object



1269
1270
1271
1272
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1269

def get_resolution_center_messages(thread_id:, filter: {}, includes: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes)
  tunes_request_client.get("resolutionCenterThreads/#{thread_id}/resolutionCenterMessages", params)
end

#get_resolution_center_threads(filter: {}, includes: nil) ⇒ Object

resolutionCenter

As of 2022-11-11: This is not official available throught the App Store Connect API using an API Key. This is only works with Apple ID auth.



1264
1265
1266
1267
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1264

def get_resolution_center_threads(filter: {}, includes: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes)
  tunes_request_client.get('resolutionCenterThreads', params)
end

#get_review_rejection(filter: {}, includes: nil) ⇒ Object



1274
1275
1276
1277
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1274

def get_review_rejection(filter: {}, includes: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes)
  tunes_request_client.get("reviewRejections", params)
end

#get_review_submission(review_submission_id:, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object



1148
1149
1150
1151
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1148

def get_review_submission(review_submission_id:, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("reviewSubmissions/#{review_submission_id}", params)
end

#get_review_submission_items(review_submission_id:, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

reviewSubmissionItems



1190
1191
1192
1193
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1190

def get_review_submission_items(review_submission_id:, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("reviewSubmissions/#{review_submission_id}/items", params)
end

#get_review_submissions(app_id:, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

reviewSubmissions



1143
1144
1145
1146
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1143

def get_review_submissions(app_id:, filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("apps/#{app_id}/reviewSubmissions", params)
end

#get_sandbox_testers(filter: nil, includes: nil, limit: nil, sort: nil) ⇒ Object

sandboxTesters



1226
1227
1228
1229
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1226

def get_sandbox_testers(filter: nil, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes, limit: limit, sort: sort)
  tunes_request_client.get("sandboxTesters", params)
end

#get_territories(filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

territories



1251
1252
1253
1254
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1251

def get_territories(filter: {}, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: nil, includes: nil, limit: nil, sort: nil)
  tunes_request_client.get("territories", params)
end

#patch_age_rating_declaration(age_rating_declaration_id: nil, attributes: nil) ⇒ Object



27
28
29
30
31
32
33
34
35
36
37
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 27

def patch_age_rating_declaration(age_rating_declaration_id: nil, attributes: nil)
  body = {
    data: {
      type: "ageRatingDeclarations",
      id: age_rating_declaration_id,
      attributes: attributes
    }
  }

  tunes_request_client.patch("ageRatingDeclarations/#{age_rating_declaration_id}", body)
end

#patch_app(app_id: nil, attributes: {}, app_price_tier_id: nil, territory_ids: nil, allow_removing_from_sale: false) ⇒ Object

Updates app attributes, price tier, visibility in regions or countries. Use territory_ids with allow_removing_from_sale to remove app from sale

Parameters:

  • territory_ids (defaults to: nil)

    updates app visibility in regions or countries. Possible values: empty array will remove app from sale if allow_removing_from_sale is true, array with territory ids will set availability to territories with those ids, nil will leave app availability on AppStore as is

  • allow_removing_from_sale (defaults to: false)

    allows for removing app from sale when territory_ids is an empty array



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
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 145

def patch_app(app_id: nil, attributes: {}, app_price_tier_id: nil, territory_ids: nil, allow_removing_from_sale: false)
  relationships = {}
  included = []

  # Price tier
  unless app_price_tier_id.nil?
    relationships[:prices] = {
      data: [
        {
          type: "appPrices",
          id: "${price1}"
        }
      ]
    }

    included << {
      type: "appPrices",
      id: "${price1}",
      attributes: {
        startDate: nil
      },
      relationships: {
        app: {
          data: {
            type: "apps",
            id: app_id
          }
        },
        priceTier: {
          data: {
            type: "appPriceTiers",
            id: app_price_tier_id.to_s
          }
        }
      }
    }
  end

  # Territories
  unless territory_ids.nil?
    territories_data = territory_ids.map do |id|
      { type: "territories", id: id }
    end
    if !territories_data.empty? || allow_removing_from_sale
      relationships[:availableTerritories] = {
        data: territories_data
      }
    end
  end

  # Data
  data = {
    type: "apps",
    id: app_id
  }
  data[:relationships] = relationships unless relationships.empty?

  if !attributes.nil? && !attributes.empty?
    data[:attributes] = attributes
  end

  # Body
  body = {
    data: data
  }
  body[:included] = included unless included.empty?

  tunes_request_client.patch("apps/#{app_id}", body)
end

#patch_app_data_usages_publish_state(app_data_usages_publish_state_id: nil, published: nil) ⇒ Object



304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 304

def patch_app_data_usages_publish_state(app_data_usages_publish_state_id: nil, published: nil)
  body = {
    data: {
      type: "appDataUsagesPublishState",
      id: app_data_usages_publish_state_id,
      attributes: {
        published: published
      }
    }
  }

  tunes_request_client.patch("appDataUsagesPublishState/#{app_data_usages_publish_state_id}", body)
end

#patch_app_info(app_info_id: nil, attributes: {}) ⇒ Object



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 594

def patch_app_info(app_info_id: nil, attributes: {})
  attributes ||= {}

  data = {
    type: "appInfos",
    id: app_info_id
  }
  data[:attributes] = attributes unless attributes.empty?

  body = {
    data: data
  }

  tunes_request_client.patch("appInfos/#{app_info_id}", body)
end

#patch_app_info_categories(app_info_id: nil, category_id_map: nil) ⇒ Object

Adding the key will create/update (if value) or delete if nil Not including a key will leave as is category_id_map:

primary_category_id: "GAMES",
primary_subcategory_one_id: "PUZZLE",
primary_subcategory_two_id: "STRATEGY",
secondary_category_id: nil,
secondary_subcategory_one_id: nil,
secondary_subcategory_two_id: nil



622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 622

def patch_app_info_categories(app_info_id: nil, category_id_map: nil)
  category_id_map ||= {}
  primary_category_id = category_id_map[:primary_category_id]
  primary_subcategory_one_id = category_id_map[:primary_subcategory_one_id]
  primary_subcategory_two_id = category_id_map[:primary_subcategory_two_id]
  secondary_category_id = category_id_map[:secondary_category_id]
  secondary_subcategory_one_id = category_id_map[:secondary_subcategory_one_id]
  secondary_subcategory_two_id = category_id_map[:secondary_subcategory_two_id]

  relationships = {}

  # Only update if key is included (otherwise category will be removed)
  if category_id_map.include?(:primary_category_id)
    relationships[:primaryCategory] = {
      data: primary_category_id ? { type: "appCategories", id: primary_category_id } : nil
    }
  end

  # Only update if key is included (otherwise category will be removed)
  if category_id_map.include?(:primary_subcategory_one_id)
    relationships[:primarySubcategoryOne] = {
      data: primary_subcategory_one_id ? { type: "appCategories", id: primary_subcategory_one_id } : nil
    }
  end

  # Only update if key is included (otherwise category will be removed)
  if category_id_map.include?(:primary_subcategory_two_id)
    relationships[:primarySubcategoryTwo] = {
      data: primary_subcategory_two_id ? { type: "appCategories", id: primary_subcategory_two_id } : nil
    }
  end

  # Only update if key is included (otherwise category will be removed)
  if category_id_map.include?(:secondary_category_id)
    relationships[:secondaryCategory] = {
      data: secondary_category_id ? { type: "appCategories", id: secondary_category_id } : nil
    }
  end

  # Only update if key is included (otherwise category will be removed)
  if category_id_map.include?(:secondary_subcategory_one_id)
    relationships[:secondarySubcategoryOne] = {
      data: secondary_subcategory_one_id ? { type: "appCategories", id: secondary_subcategory_one_id } : nil
    }
  end

  # Only update if key is included (otherwise category will be removed)
  if category_id_map.include?(:secondary_subcategory_two_id)
    relationships[:secondarySubcategoryTwo] = {
      data: secondary_subcategory_two_id ? { type: "appCategories", id: secondary_subcategory_two_id } : nil
    }
  end

  data = {
    type: "appInfos",
    id: app_info_id
  }
  data[:relationships] = relationships unless relationships.empty?

  body = {
    data: data
  }

  tunes_request_client.patch("appInfos/#{app_info_id}", body)
end

#patch_app_info_localization(app_info_localization_id: nil, attributes: {}) ⇒ Object



721
722
723
724
725
726
727
728
729
730
731
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 721

def patch_app_info_localization(app_info_localization_id: nil, attributes: {})
  body = {
    data: {
      type: "appInfoLocalizations",
      id: app_info_localization_id,
      attributes: attributes
    }
  }

  tunes_request_client.patch("appInfoLocalizations/#{app_info_localization_id}", body)
end

#patch_app_preview(app_preview_id: nil, attributes: {}) ⇒ Object



346
347
348
349
350
351
352
353
354
355
356
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 346

def patch_app_preview(app_preview_id: nil, attributes: {})
  body = {
    data: {
      type: "appPreviews",
      id: app_preview_id,
      attributes: attributes
    }
  }

  tunes_request_client.patch("appPreviews/#{app_preview_id}", body)
end

#patch_app_preview_set_previews(app_preview_set_id: nil, app_preview_ids: nil) ⇒ Object



401
402
403
404
405
406
407
408
409
410
411
412
413
414
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 401

def patch_app_preview_set_previews(app_preview_set_id: nil, app_preview_ids: nil)
  app_preview_ids ||= []

  body = {
    data: app_preview_ids.map do |app_preview_id|
      {
        type: "appPreviews",
        id: app_preview_id
      }
    end
  }

  tunes_request_client.patch("appPreviewSets/#{app_preview_set_id}/relationships/appPreviews", body)
end

#patch_app_screenshot(app_screenshot_id: nil, attributes: {}) ⇒ Object



568
569
570
571
572
573
574
575
576
577
578
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 568

def patch_app_screenshot(app_screenshot_id: nil, attributes: {})
  body = {
    data: {
      type: "appScreenshots",
      id: app_screenshot_id,
      attributes: attributes
    }
  }

  tunes_request_client.patch("appScreenshots/#{app_screenshot_id}", body)
end

#patch_app_screenshot_set_screenshots(app_screenshot_set_id: nil, app_screenshot_ids: nil) ⇒ Object



520
521
522
523
524
525
526
527
528
529
530
531
532
533
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 520

def patch_app_screenshot_set_screenshots(app_screenshot_set_id: nil, app_screenshot_ids: nil)
  app_screenshot_ids ||= []

  body = {
    data: app_screenshot_ids.map do |app_screenshot_id|
      {
        type: "appScreenshots",
        id: app_screenshot_id
      }
    end
  }

  tunes_request_client.patch("appScreenshotSets/#{app_screenshot_set_id}/relationships/appScreenshots", body)
end

#patch_app_store_review_attachment(app_store_review_attachment_id: nil, attributes: {}) ⇒ Object



470
471
472
473
474
475
476
477
478
479
480
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 470

def patch_app_store_review_attachment(app_store_review_attachment_id: nil, attributes: {})
  body = {
    data: {
      type: "appStoreReviewAttachments",
      id: app_store_review_attachment_id,
      attributes: attributes
    }
  }

  tunes_request_client.patch("appStoreReviewAttachments/#{app_store_review_attachment_id}", body)
end

#patch_app_store_review_detail(app_store_review_detail_id: nil, attributes: {}) ⇒ Object



761
762
763
764
765
766
767
768
769
770
771
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 761

def patch_app_store_review_detail(app_store_review_detail_id: nil, attributes: {})
  body = {
    data: {
      type: "appStoreReviewDetails",
      id: app_store_review_detail_id,
      attributes: attributes
    }
  }

  tunes_request_client.patch("appStoreReviewDetails/#{app_store_review_detail_id}", body)
end

#patch_app_store_version(app_store_version_id: nil, attributes: {}) ⇒ Object



901
902
903
904
905
906
907
908
909
910
911
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 901

def patch_app_store_version(app_store_version_id: nil, attributes: {})
  body = {
    data: {
      type: "appStoreVersions",
      id: app_store_version_id,
      attributes: attributes
    }
  }

  tunes_request_client.patch("appStoreVersions/#{app_store_version_id}", body)
end

#patch_app_store_version_localization(app_store_version_localization_id: nil, attributes: {}) ⇒ Object



806
807
808
809
810
811
812
813
814
815
816
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 806

def patch_app_store_version_localization(app_store_version_localization_id: nil, attributes: {})
  body = {
    data: {
      type: "appStoreVersionLocalizations",
      id: app_store_version_localization_id,
      attributes: attributes
    }
  }

  tunes_request_client.patch("appStoreVersionLocalizations/#{app_store_version_localization_id}", body)
end

#patch_app_store_version_phased_release(app_store_version_phased_release_id: nil, attributes: {}) ⇒ Object



851
852
853
854
855
856
857
858
859
860
861
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 851

def patch_app_store_version_phased_release(app_store_version_phased_release_id: nil, attributes: {})
  body = {
    data: {
      type: "appStoreVersionPhasedReleases",
      attributes: attributes,
      id: app_store_version_phased_release_id
    }
  }

  tunes_request_client.patch("appStoreVersionPhasedReleases/#{app_store_version_phased_release_id}", body)
end

#patch_app_store_version_with_build(app_store_version_id: nil, build_id: nil) ⇒ Object



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 913

def patch_app_store_version_with_build(app_store_version_id: nil, build_id: nil)
  data = nil
  if build_id
    data = {
      type: "builds",
      id: build_id
    }
  end

  body = {
    data: {
      type: "appStoreVersions",
      id: app_store_version_id,
      relationships: {
        build: {
          data: data
        }
      }
    }
  }

  tunes_request_client.patch("appStoreVersions/#{app_store_version_id}", body)
end

#patch_idfa_declaration(idfa_declaration_id: nil, attributes: nil) ⇒ Object



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1122

def patch_idfa_declaration(idfa_declaration_id: nil, attributes: nil)
  body = {
    data: {
      type: "idfaDeclarations",
      id: idfa_declaration_id,
      attributes: attributes
    }
  }

  tunes_request_client.patch("idfaDeclarations/#{idfa_declaration_id}", body)
end

#patch_review_submission(review_submission_id:, attributes: nil) ⇒ Object



1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1174

def patch_review_submission(review_submission_id:, attributes: nil)
  body = {
    data: {
      type: "reviewSubmissions",
      id: review_submission_id,
      attributes: attributes,
    }
  }

  tunes_request_client.patch("reviewSubmissions/#{review_submission_id}", body)
end

#post_app(name: nil, version_string: nil, sku: nil, primary_locale: nil, bundle_id: nil, platforms: nil, company_name: nil) ⇒ Object

app



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
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 43

def post_app(name: nil, version_string: nil, sku: nil, primary_locale: nil, bundle_id: nil, platforms: nil, company_name: nil)
  included = []
  included << {
    type: "appInfos",
    id: "${new-appInfo-id}",
    relationships: {
      appInfoLocalizations: {
        data: [
          {
            type: "appInfoLocalizations",
            id: "${new-appInfoLocalization-id}"
          }
        ]
      }
    }
  }
  included << {
    type: "appInfoLocalizations",
    id: "${new-appInfoLocalization-id}",
    attributes: {
      locale: primary_locale,
      name: name
    }
  }

  platforms.each do |platform|
    included << {
      type: "appStoreVersions",
      id: "${store-version-#{platform}}",
      attributes: {
        platform: platform,
        versionString: version_string
      },
      relationships: {
        appStoreVersionLocalizations: {
          data: [
            {
              type: "appStoreVersionLocalizations",
              id: "${new-#{platform}VersionLocalization-id}"
            }
          ]
        }
      }
    }

    included << {
      type: "appStoreVersionLocalizations",
      id: "${new-#{platform}VersionLocalization-id}",
      attributes: {
        locale: primary_locale
      }
    }
  end

  app_store_verions_data = platforms.map do |platform|
    {
      type: "appStoreVersions",
      id: "${store-version-#{platform}}"
    }
  end

  relationships = {
    appStoreVersions: {
      data: app_store_verions_data
    },
    appInfos: {
      data: [
        {
          type: "appInfos",
          id: "${new-appInfo-id}"
        }
      ]
    }
  }

  app_attributes = {
    sku: sku,
    primaryLocale: primary_locale,
    bundleId: bundle_id
  }
  app_attributes[:companyName] = company_name if company_name

  body = {
    data: {
      type: "apps",
      attributes: app_attributes,
      relationships: relationships
    },
    included: included
  }

  tunes_request_client.post("apps", body)
end

#post_app_data_usage(app_id:, app_data_usage_category_id: nil, app_data_usage_protection_id: nil, app_data_usage_purpose_id: nil) ⇒ Object



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 224

def post_app_data_usage(app_id:, app_data_usage_category_id: nil, app_data_usage_protection_id: nil, app_data_usage_purpose_id: nil)
  raise "app_id is required " if app_id.nil?

  relationships = {
    app: {
      data: {
        type: "apps",
        id: app_id
      }
    }
  }

  if app_data_usage_category_id
    relationships[:category] = {
      data: {
        type: "appDataUsageCategories",
        id: app_data_usage_category_id
      }
    }
  end

  if app_data_usage_protection_id
    relationships[:dataProtection] = {
      data: {
        type: "appDataUsageDataProtections",
        id: app_data_usage_protection_id
      }
    }
  end

  if app_data_usage_purpose_id
    relationships[:purpose] = {
      data: {
        type: "appDataUsagePurposes",
        id: app_data_usage_purpose_id
      }
    }
  end

  body = {
    data: {
      type: "appDataUsages",
      relationships: relationships
    }
  }

  tunes_request_client.post("appDataUsages", body)
end

#post_app_info_localization(app_info_id: nil, attributes: {}) ⇒ Object



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 702

def post_app_info_localization(app_info_id: nil, attributes: {})
  body = {
    data: {
      type: "appInfoLocalizations",
      attributes: attributes,
      relationships: {
        appStoreVersion: {
          data: {
            type: "appStoreVersions",
            id: app_info_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appInfoLocalizations", body)
end

#post_app_preview(app_preview_set_id: nil, attributes: {}) ⇒ Object



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 327

def post_app_preview(app_preview_set_id: nil, attributes: {})
  body = {
    data: {
      type: "appPreviews",
      attributes: attributes,
      relationships: {
        appPreviewSet: {
          data: {
            type: "appPreviewSets",
            id: app_preview_set_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appPreviews", body)
end

#post_app_preview_set(app_store_version_localization_id: nil, attributes: {}) ⇒ Object



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 377

def post_app_preview_set(app_store_version_localization_id: nil, attributes: {})
  body = {
    data: {
      type: "appPreviewSets",
      attributes: attributes,
      relationships: {
        appStoreVersionLocalization: {
          data: {
            type: "appStoreVersionLocalizations",
            id: app_store_version_localization_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appPreviewSets", body)
end

#post_app_screenshot(app_screenshot_set_id: nil, attributes: {}) ⇒ Object



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 549

def post_app_screenshot(app_screenshot_set_id: nil, attributes: {})
  body = {
    data: {
      type: "appScreenshots",
      attributes: attributes,
      relationships: {
        appScreenshotSet: {
          data: {
            type: "appScreenshotSets",
            id: app_screenshot_set_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appScreenshots", body, tries: 1)
end

#post_app_screenshot_set(app_store_version_localization_id: nil, attributes: {}) ⇒ Object



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 501

def post_app_screenshot_set(app_store_version_localization_id: nil, attributes: {})
  body = {
    data: {
      type: "appScreenshotSets",
      attributes: attributes,
      relationships: {
        appStoreVersionLocalization: {
          data: {
            type: "appStoreVersionLocalizations",
            id: app_store_version_localization_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appScreenshotSets", body)
end

#post_app_store_review_attachment(app_store_review_detail_id: nil, attributes: {}) ⇒ Object

appReviewAttachments



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 451

def post_app_store_review_attachment(app_store_review_detail_id: nil, attributes: {})
  body = {
    data: {
      type: "appStoreReviewAttachments",
      attributes: attributes,
      relationships: {
        appStoreReviewDetail: {
          data: {
            type: "appStoreReviewDetails",
            id: app_store_review_detail_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appStoreReviewAttachments", body)
end

#post_app_store_review_detail(app_store_version_id: nil, attributes: {}) ⇒ Object



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 742

def post_app_store_review_detail(app_store_version_id: nil, attributes: {})
  body = {
    data: {
      type: "appStoreReviewDetails",
      attributes: attributes,
      relationships: {
        appStoreVersion: {
          data: {
            type: "appStoreVersions",
            id: app_store_version_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appStoreReviewDetails", body)
end

#post_app_store_version(app_id: nil, attributes: {}) ⇒ Object



882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 882

def post_app_store_version(app_id: nil, attributes: {})
  body = {
    data: {
      type: "appStoreVersions",
      attributes: attributes,
      relationships: {
        app: {
          data: {
            type: "apps",
            id: app_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appStoreVersions", body)
end

#post_app_store_version_localization(app_store_version_id: nil, attributes: {}) ⇒ Object



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 787

def post_app_store_version_localization(app_store_version_id: nil, attributes: {})
  body = {
    data: {
      type: "appStoreVersionLocalizations",
      attributes: attributes,
      relationships: {
        appStoreVersion: {
          data: {
            type: "appStoreVersions",
            id: app_store_version_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appStoreVersionLocalizations", body)
end

#post_app_store_version_phased_release(app_store_version_id: nil, attributes: {}) ⇒ Object



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 832

def post_app_store_version_phased_release(app_store_version_id: nil, attributes: {})
  body = {
    data: {
      type: "appStoreVersionPhasedReleases",
      attributes: attributes,
      relationships: {
        appStoreVersion: {
          data: {
            type: "appStoreVersions",
            id: app_store_version_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appStoreVersionPhasedReleases", body)
end

#post_app_store_version_release_request(app_store_version_id: nil) ⇒ Object

appStoreVersionReleaseRequests



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1005

def post_app_store_version_release_request(app_store_version_id: nil)
  body = {
      data: {
          type: "appStoreVersionReleaseRequests",
          relationships: {
              appStoreVersion: {
                  data: {
                      type: "appStoreVersions",
                      id: app_store_version_id
                  }
              }
          }
      }
  }

  tunes_request_client.post("appStoreVersionReleaseRequests", body)
end

#post_app_store_version_submission(app_store_version_id: nil) ⇒ Object



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 978

def post_app_store_version_submission(app_store_version_id: nil)
  body = {
    data: {
      type: "appStoreVersionSubmissions",
      relationships: {
        appStoreVersion: {
          data: {
            type: "appStoreVersions",
            id: app_store_version_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appStoreVersionSubmissions", body)
end

#post_custom_app_organization(app_id: nil, device_enrollment_program_id: nil, name: nil) ⇒ Object



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1067

def post_custom_app_organization(app_id: nil, device_enrollment_program_id: nil, name: nil)
  body = {
      data: {
          type: "customAppOrganizations",
          attributes: {
            deviceEnrollmentProgramId: device_enrollment_program_id,
            name: name
          },
          relationships: {
              app: {
                  data: {
                      type: "apps",
                      id: app_id
                  }
              }
          }
      }
  }

  tunes_request_client.post("customAppOrganizations", body)
end

#post_custom_app_user(app_id: nil, apple_id: nil) ⇒ Object



1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1032

def post_custom_app_user(app_id: nil, apple_id: nil)
  body = {
      data: {
          type: "customAppUsers",
          attributes: {
            appleId: apple_id
          },
          relationships: {
              app: {
                  data: {
                      type: "apps",
                      id: app_id
                  }
              }
          }
      }
  }

  tunes_request_client.post("customAppUsers", body)
end

#post_idfa_declaration(app_store_version_id: nil, attributes: nil) ⇒ Object



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1103

def post_idfa_declaration(app_store_version_id: nil, attributes: nil)
  body = {
    data: {
      type: "idfaDeclarations",
      attributes: attributes,
      relationships: {
        appStoreVersion: {
          data: {
            type: "appStoreVersions",
            id: app_store_version_id
          }
        }
      }
    }
  }

  tunes_request_client.post("idfaDeclarations", body)
end

#post_reset_ratings_request(app_store_version_id: nil) ⇒ Object



946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 946

def post_reset_ratings_request(app_store_version_id: nil)
  body = {
    data: {
      type: "resetRatingsRequests",
      relationships: {
        appStoreVersion: {
          data: {
            type: "appStoreVersions",
            id: app_store_version_id
          }
        }
      }
    }
  }

  tunes_request_client.post("resetRatingsRequests", body)
end

#post_review_submission(app_id:, platform:) ⇒ Object



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1153

def post_review_submission(app_id:, platform:)
  body = {
    data: {
      type: "reviewSubmissions",
      attributes: {
        platform: platform
      },
      relationships: {
        app: {
          data: {
            type: "apps",
            id: app_id
          }
        }
      }
    }
  }

  tunes_request_client.post("reviewSubmissions", body)
end

#post_review_submission_item(review_submission_id:, app_store_version_id: nil) ⇒ Object



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1195

def post_review_submission_item(review_submission_id:, app_store_version_id: nil)
  body = {
    data: {
      type: "reviewSubmissionItems",
      relationships: {
        reviewSubmission: {
          data: {
            type: "reviewSubmissions",
            id: review_submission_id
          }
        }
      }
    }
  }

  unless app_store_version_id.nil?
    body[:data][:relationships][:appStoreVersion] = {
      data: {
        type: "appStoreVersions",
        id: app_store_version_id
      }
    }
  end

  tunes_request_client.post("reviewSubmissionItems", body)
end

#post_sandbox_tester(attributes: {}) ⇒ Object



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1231

def post_sandbox_tester(attributes: {})
  body = {
    data: {
      type: "sandboxTesters",
      attributes: attributes
    }
  }

  tunes_request_client.post("sandboxTesters", body)
end

#tunes_request_clientObject

Raises:

  • (TypeError)


11
12
13
14
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 11

def tunes_request_client
  return @tunes_request_client if @tunes_request_client
  raise TypeError, "You need to instantiate this module with tunes_request_client"
end

#tunes_request_client=(tunes_request_client) ⇒ Object



7
8
9
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 7

def tunes_request_client=(tunes_request_client)
  @tunes_request_client = tunes_request_client
end