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

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

Defined Under Namespace

Modules: Version

Instance Method Summary collapse

Instance Method Details

#delete_app_data_usage(app_data_usage_id: nil) ⇒ Object



276
277
278
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 276

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

#delete_app_info(app_info_id: nil) ⇒ Object



691
692
693
694
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 691

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("#{Version::V1}/appInfos/#{app_info_id}", params)
end

#delete_app_preview(app_preview_id: nil) ⇒ Object



361
362
363
364
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 361

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("#{Version::V1}/appPreviews/#{app_preview_id}", params)
end

#delete_app_preview_set(app_preview_set_id: nil) ⇒ Object



399
400
401
402
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 399

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("#{Version::V1}/appPreviewSets/#{app_preview_set_id}", params)
end

#delete_app_screenshot(app_screenshot_id: nil) ⇒ Object



583
584
585
586
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 583

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("#{Version::V1}/appScreenshots/#{app_screenshot_id}", params)
end

#delete_app_screenshot_set(app_screenshot_set_id: nil) ⇒ Object



538
539
540
541
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 538

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("#{Version::V1}/appScreenshotSets/#{app_screenshot_set_id}", params)
end

#delete_app_store_review_attachment(app_store_review_attachment_id: nil) ⇒ Object



485
486
487
488
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 485

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("#{Version::V1}/appStoreReviewAttachments/#{app_store_review_attachment_id}", params)
end

#delete_app_store_version_localization(app_store_version_localization_id: nil) ⇒ Object



821
822
823
824
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 821

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("#{Version::V1}/appStoreVersionLocalizations/#{app_store_version_localization_id}", params)
end

#delete_app_store_version_phased_release(app_store_version_phased_release_id: nil) ⇒ Object



866
867
868
869
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 866

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("#{Version::V1}/appStoreVersionPhasedReleases/#{app_store_version_phased_release_id}", params)
end

#delete_app_store_version_submission(app_store_version_submission_id: nil) ⇒ Object



999
1000
1001
1002
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 999

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("#{Version::V1}/appStoreVersionSubmissions/#{app_store_version_submission_id}", params)
end

#delete_custom_app_organization(custom_app_organization_id: nil) ⇒ Object



1092
1093
1094
1095
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1092

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("#{Version::V1}/customAppOrganizations/#{custom_app_organization_id}", params)
end

#delete_custom_app_user(custom_app_user_id: nil) ⇒ Object



1056
1057
1058
1059
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1056

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("#{Version::V1}/customAppUsers/#{custom_app_user_id}", params)
end

#delete_reset_ratings_request(reset_ratings_request_id: nil) ⇒ Object



967
968
969
970
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 967

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("#{Version::V1}/resetRatingsRequests/#{reset_ratings_request_id}", params)
end

#delete_sandbox_tester(sandbox_tester_id: nil) ⇒ Object



1200
1201
1202
1203
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1200

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("#{Version::V1}/sandboxTesters/#{sandbox_tester_id}", params)
end

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

ageRatingDeclarations



26
27
28
29
30
31
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 26

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("#{Version::V1}/appInfos/#{app_info_id}/ageRatingDeclaration", params)
end

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

appDataUsageCategory



284
285
286
287
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 284

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("#{Version::V1}/appDataUsageCategories", params)
end

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

appDataUsagePurpose



293
294
295
296
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 293

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("#{Version::V1}/appDataUsagePurposes", params)
end

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

appDataUsage



222
223
224
225
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 222

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("#{Version::V1}/apps/#{app_id}/dataUsages", params)
end

#get_app_data_usages_publish_state(app_id: nil) ⇒ Object

appDataUsagesPublishState



302
303
304
305
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 302

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("#{Version::V1}/apps/#{app_id}/dataUsagePublishState", params)
end

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

appInfoLocalizations



700
701
702
703
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 700

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("#{Version::V1}/appInfos/#{app_info_id}/appInfoLocalizations", params)
end

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

appInfos



592
593
594
595
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 592

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("#{Version::V1}/apps/#{app_id}/appInfos", params)
end

#get_app_preview(app_preview_id: nil) ⇒ Object

appPreview



325
326
327
328
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 325

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("#{Version::V1}/appPreviews/#{app_preview_id}", params)
end

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



375
376
377
378
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 375

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("#{Version::V1}/appPreviewSets/#{app_preview_set_id}", params)
end

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

appPreviewSets



370
371
372
373
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 370

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("#{Version::V1}/appPreviewSets", params)
end

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



437
438
439
440
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 437

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("#{Version::V1}/appPrices/#{app_price_id}", params)
end

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

appPricePoints



445
446
447
448
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 445

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("#{Version::V1}/appPricePoints", params)
end

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

appPrices



432
433
434
435
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 432

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("#{Version::V1}/appPrices", params)
end

#get_app_screenshot(app_screenshot_id: nil) ⇒ Object

appScreenshots



547
548
549
550
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 547

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("#{Version::V1}/appScreenshots/#{app_screenshot_id}", params)
end

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



499
500
501
502
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 499

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("#{Version::V1}/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



494
495
496
497
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 494

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("#{Version::V1}/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



740
741
742
743
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 740

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("#{Version::V1}/appStoreVersions/#{app_store_version_id}/appStoreReviewDetail", params)
end

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



880
881
882
883
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 880

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("#{Version::V1}/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



785
786
787
788
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 785

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("#{Version::V1}/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



780
781
782
783
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 780

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("#{Version::V1}/appStoreVersions/#{app_store_version_id}/appStoreVersionLocalizations", params)
end

#get_app_store_version_phased_release(app_store_version_id: nil) ⇒ Object

appStoreVersionPhasedReleases



830
831
832
833
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 830

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("#{Version::V1}/appStoreVersions/#{app_store_version_id}/appStoreVersionPhasedRelease", params)
end

#get_app_store_version_submission(app_store_version_id: nil) ⇒ Object

appStoreVersionSubmissions



976
977
978
979
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 976

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("#{Version::V1}/appStoreVersions/#{app_store_version_id}/appStoreVersionSubmission", params)
end

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

appStoreVersions



875
876
877
878
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 875

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("#{Version::V1}/apps/#{app_id}/appStoreVersions", params)
end

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

availableTerritories



423
424
425
426
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 423

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("#{Version::V1}/apps/#{app_id}/availableTerritories", params)
end

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

customOrganizationUsers



1065
1066
1067
1068
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1065

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("#{Version::V1}/apps/#{app_id}/customAppOrganizations", params)
end

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

customAppUsers



1030
1031
1032
1033
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1030

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("#{Version::V1}/apps/#{app_id}/customAppUsers", params)
end

#get_reset_ratings_request(app_store_version_id: nil) ⇒ Object

appStoreVersionPhasedReleases



944
945
946
947
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 944

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("#{Version::V1}/appStoreVersions/#{app_store_version_id}/resetRatingsRequest", params)
end

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



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

def get_resolution_center_messages(thread_id:, filter: {}, includes: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes)
  tunes_request_client.get("#{Version::V1}/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 through the App Store Connect API using an API Key. This is only works with Apple ID auth.



1222
1223
1224
1225
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1222

def get_resolution_center_threads(filter: {}, includes: nil)
  params = tunes_request_client.build_params(filter: filter, includes: includes)
  tunes_request_client.get("#{Version::V1}/resolutionCenterThreads", params)
end

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



1232
1233
1234
1235
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1232

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

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



1106
1107
1108
1109
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1106

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("#{Version::V1}/reviewSubmissions/#{review_submission_id}", params)
end

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

reviewSubmissionItems



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

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("#{Version::V1}/reviewSubmissions/#{review_submission_id}/items", params)
end

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

reviewSubmissions



1101
1102
1103
1104
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1101

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("#{Version::V1}/apps/#{app_id}/reviewSubmissions", params)
end

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

sandboxTesters



1184
1185
1186
1187
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1184

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("#{Version::V1}/sandboxTesters", params)
end

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

territories



1209
1210
1211
1212
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1209

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("#{Version::V1}/territories", params)
end

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



33
34
35
36
37
38
39
40
41
42
43
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 33

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("#{Version::V1}/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



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

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}",
      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("#{Version::V1}/apps/#{app_id}", body)
end

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



307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 307

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("#{Version::V1}/appDataUsagesPublishState/#{app_data_usages_publish_state_id}", body)
end

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



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

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("#{Version::V1}/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



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

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("#{Version::V1}/appInfos/#{app_info_id}", body)
end

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



724
725
726
727
728
729
730
731
732
733
734
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 724

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("#{Version::V1}/appInfoLocalizations/#{app_info_localization_id}", body)
end

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



349
350
351
352
353
354
355
356
357
358
359
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 349

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

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

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



404
405
406
407
408
409
410
411
412
413
414
415
416
417
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 404

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("#{Version::V1}/appPreviewSets/#{app_preview_set_id}/relationships/appPreviews", body)
end

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



571
572
573
574
575
576
577
578
579
580
581
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 571

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

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

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



523
524
525
526
527
528
529
530
531
532
533
534
535
536
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 523

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("#{Version::V1}/appScreenshotSets/#{app_screenshot_set_id}/relationships/appScreenshots", body)
end

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



473
474
475
476
477
478
479
480
481
482
483
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 473

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("#{Version::V1}/appStoreReviewAttachments/#{app_store_review_attachment_id}", body)
end

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



764
765
766
767
768
769
770
771
772
773
774
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 764

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("#{Version::V1}/appStoreReviewDetails/#{app_store_review_detail_id}", body)
end

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



904
905
906
907
908
909
910
911
912
913
914
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 904

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("#{Version::V1}/appStoreVersions/#{app_store_version_id}", body)
end

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



809
810
811
812
813
814
815
816
817
818
819
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 809

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("#{Version::V1}/appStoreVersionLocalizations/#{app_store_version_localization_id}", body)
end

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



854
855
856
857
858
859
860
861
862
863
864
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 854

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("#{Version::V1}/appStoreVersionPhasedReleases/#{app_store_version_phased_release_id}", body)
end

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



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

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("#{Version::V1}/appStoreVersions/#{app_store_version_id}", body)
end

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



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1132

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

  tunes_request_client.patch("#{Version::V1}/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



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

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

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

  relationships = {
    appStoreVersions: {
      data: data_for_app_store_versions
    },
    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("#{Version::V1}/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



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

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("#{Version::V1}/appDataUsages", body)
end

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



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

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("#{Version::V1}/appInfoLocalizations", body)
end

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



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

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("#{Version::V1}/appPreviews", body)
end

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



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

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("#{Version::V1}/appPreviewSets", body)
end

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



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

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("#{Version::V1}/appScreenshots", body, tries: 1)
end

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



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

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("#{Version::V1}/appScreenshotSets", body)
end

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

appReviewAttachments



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

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("#{Version::V1}/appStoreReviewAttachments", body)
end

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



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

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("#{Version::V1}/appStoreReviewDetails", body)
end

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



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

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("#{Version::V1}/appStoreVersions", body)
end

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



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

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("#{Version::V1}/appStoreVersionLocalizations", body)
end

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



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

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("#{Version::V1}/appStoreVersionPhasedReleases", body)
end

#post_app_store_version_release_request(app_store_version_id: nil) ⇒ Object

appStoreVersionReleaseRequests



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

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("#{Version::V1}/appStoreVersionReleaseRequests", body)
end

#post_app_store_version_submission(app_store_version_id: nil) ⇒ Object



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

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("#{Version::V1}/appStoreVersionSubmissions", body)
end

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



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

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("#{Version::V1}/customAppOrganizations", body)
end

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



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

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("#{Version::V1}/customAppUsers", body)
end

#post_reset_ratings_request(app_store_version_id: nil) ⇒ Object



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

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("#{Version::V1}/resetRatingsRequests", body)
end

#post_review_submission(app_id:, platform:) ⇒ Object



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1111

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("#{Version::V1}/reviewSubmissions", body)
end

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



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

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("#{Version::V1}/reviewSubmissionItems", body)
end

#post_sandbox_tester(attributes: {}) ⇒ Object



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1189

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

  tunes_request_client.post("#{Version::V1}/sandboxTesters", body)
end

#tunes_request_clientObject

Raises:

  • (TypeError)


17
18
19
20
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 17

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



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

def tunes_request_client=(tunes_request_client)
  @tunes_request_client = tunes_request_client
end