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_clip_header_image(app_clip_header_image_id: nil) ⇒ Object



1477
1478
1479
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1477

def delete_app_clip_header_image(app_clip_header_image_id: nil)
  tunes_request_client.delete("#{Version::V1}/appClipHeaderImages/#{app_clip_header_image_id}")
end

#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



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

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



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

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



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

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



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

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



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

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



910
911
912
913
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 910

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



1043
1044
1045
1046
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1043

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_beta_app_clip_invocation(beta_app_clip_invocation_id:) ⇒ Object



1533
1534
1535
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1533

def delete_beta_app_clip_invocation(beta_app_clip_invocation_id:)
  tunes_request_client.delete("#{Version::V1}/betaAppClipInvocations/#{beta_app_clip_invocation_id}")
end

#delete_custom_app_organization(custom_app_organization_id: nil) ⇒ Object



1136
1137
1138
1139
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1136

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



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

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



1011
1012
1013
1014
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1011

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



1244
1245
1246
1247
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1244

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

#delete_webhook(webhook_id:) ⇒ Object



1315
1316
1317
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1315

def delete_webhook(webhook_id:)
  tunes_request_client.delete("#{Version::V1}/webhooks/#{webhook_id}")
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_availabilities(app_id: nil, filter: nil, includes: nil, limit: nil, sort: nil) ⇒ Object

appAvailabilities



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

def get_app_availabilities(app_id: nil, filter: nil, includes: nil, limit: nil, sort: nil)
  params = tunes_request_client.build_params(filter: nil, includes: includes, limit: limit, sort: nil)
  tunes_request_client.get("#{Version::V2}/appAvailabilities/#{app_id}", params)
end

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

appClipDefaultExperiences



1332
1333
1334
1335
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1332

def get_app_clip_default_experience(app_clip_default_experience_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}/appClipDefaultExperiences/#{app_clip_default_experience_id}", params)
end

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

appClipDefaultExperienceLocalizations



1395
1396
1397
1398
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1395

def get_app_clip_default_experience_header_image(app_clip_default_experience_localization_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}/appClipDefaultExperienceLocalizations/#{app_clip_default_experience_localization_id}/relationships/appClipHeaderImage", params)
end

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



1337
1338
1339
1340
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1337

def get_app_clip_default_experience_localizations(app_clip_default_experience_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}/appClipDefaultExperiences/#{app_clip_default_experience_id}/appClipDefaultExperienceLocalizations", params)
end

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



1438
1439
1440
1441
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1438

def get_app_clip_header_image(app_clip_header_image_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}/appClipHeaderImages/#{app_clip_header_image_id}", params)
end

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

appClips



1323
1324
1325
1326
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1323

def get_app_clips(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}/appClips", 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



709
710
711
712
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 709

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



601
602
603
604
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 601

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(app_store_version_localization_id: nil, 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(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}/appPreviewSets", params)
end

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



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

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



454
455
456
457
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 454

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



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

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



556
557
558
559
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 556

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



508
509
510
511
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 508

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



503
504
505
506
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 503

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



749
750
751
752
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 749

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



924
925
926
927
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 924

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



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

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



824
825
826
827
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 824

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



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

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



1020
1021
1022
1023
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1020

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



919
920
921
922
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 919

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



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

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_build_bundles_beta_app_clip_invocations(build_bundle_id:, filter: {}, includes: nil, limit: nil, sort: nil) ⇒ Object

betaAppClipInvocations



1485
1486
1487
1488
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1485

def get_build_bundles_beta_app_clip_invocations(build_bundle_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}/buildBundles/#{build_bundle_id}/betaAppClipInvocations", params)
end

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

customOrganizationUsers



1109
1110
1111
1112
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1109

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



1074
1075
1076
1077
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1074

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



988
989
990
991
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 988

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



1271
1272
1273
1274
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1271

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.



1266
1267
1268
1269
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1266

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



1276
1277
1278
1279
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1276

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



1150
1151
1152
1153
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1150

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



1192
1193
1194
1195
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1192

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



1145
1146
1147
1148
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1145

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



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

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



1253
1254
1255
1256
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1253

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

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

webhooks



1285
1286
1287
1288
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1285

def get_webhooks(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}/webhooks", 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_clip_app_store_review_detail(app_clip_app_store_review_detail_id: nil, attributes: {}) ⇒ Object



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

def patch_app_clip_app_store_review_detail(app_clip_app_store_review_detail_id: nil, attributes: {})
  body = {
    data: {
      type: "appClipAppStoreReviewDetails",
      id: app_clip_app_store_review_detail_id,
      attributes: attributes
    }
  }

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

#patch_app_clip_default_experience(default_experience_id: nil, attributes: {}) ⇒ Object



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1379

def patch_app_clip_default_experience(default_experience_id: nil, attributes: {})
  body = {
    data: {
      id: default_experience_id,
      type: "appClipDefaultExperiences",
      attributes: attributes
    }
  }

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

#patch_app_clip_default_experience_localization(app_clip_default_experience_localization_id: nil, attributes: {}) ⇒ Object



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1421

def patch_app_clip_default_experience_localization(app_clip_default_experience_localization_id: nil, attributes: {})
  body = {
    data: {
      id: app_clip_default_experience_localization_id,
      type: "appClipDefaultExperienceLocalizations",
      attributes: attributes
    }
  }

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

#patch_app_clip_header_image(app_clip_header_image_id: nil, attributes: {}) ⇒ Object



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1464

def patch_app_clip_header_image(app_clip_header_image_id: nil, attributes: {})
  body = {
    data: {
      type: "appClipHeaderImages",
      id: app_clip_header_image_id,
      attributes: attributes
    }
  }

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



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 606

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



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
690
691
692
693
694
695
696
697
698
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 634

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



733
734
735
736
737
738
739
740
741
742
743
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 733

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



580
581
582
583
584
585
586
587
588
589
590
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 580

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



532
533
534
535
536
537
538
539
540
541
542
543
544
545
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 532

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



482
483
484
485
486
487
488
489
490
491
492
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 482

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



773
774
775
776
777
778
779
780
781
782
783
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 773

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



948
949
950
951
952
953
954
955
956
957
958
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 948

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



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

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



898
899
900
901
902
903
904
905
906
907
908
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 898

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



960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 960

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_beta_app_clip_invocation_localization(beta_app_clip_invocation_localization_id:, attributes:) ⇒ Object



1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1563

def patch_beta_app_clip_invocation_localization(beta_app_clip_invocation_localization_id:, attributes:)
  body = {
    data: {
      type: "betaAppClipInvocationLocalizations",
      id: beta_app_clip_invocation_localization_id,
      attributes: attributes
    }
  }

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

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



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

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_clip_app_store_review_detail(app_clip_default_experience_id: nil, attributes: {}) ⇒ Object

appClipAppStoreReviewDetails



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

def post_app_clip_app_store_review_detail(app_clip_default_experience_id: nil, attributes: {})
  body = {
    data: {
      type: "appClipAppStoreReviewDetails",
      attributes: attributes,
      relationships: {
        appClipDefaultExperience: {
          data: {
            type: "appClipDefaultExperiences",
            id: app_clip_default_experience_id
          }
        }
      }
    }
  }

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

#post_app_clip_default_experience(app_clip_id: nil, app_store_version_id: nil, attributes:, template_default_experience_id: nil) ⇒ Object



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1343

def post_app_clip_default_experience(app_clip_id: nil, app_store_version_id: nil, attributes:, template_default_experience_id: nil)
  body = {
    data: {
      type: "appClipDefaultExperiences",
      relationships: {
        appClip: {
          data: {
            type: 'appClips',
            id: app_clip_id
          }
        },
        releaseWithAppStoreVersion: {
          data: {
            type: "appStoreVersions",
            id: app_store_version_id
          }
        }
      }
    }
  }

  body[:data][:attributes] = attributes unless attributes.nil?

  unless template_default_experience_id.nil?
    body[:data][:relationships][:appClipDefaultExperienceTemplate] = {
      data: {
        id: template_default_experience_id,
        type: 'appClipDefaultExperiences'
      }
    }
  end

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

#post_app_clip_default_experience_localization(default_experience_id: nil, attributes: {}) ⇒ Object



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1401

def post_app_clip_default_experience_localization(default_experience_id: nil, attributes: {})
  body = {
    data: {
      type: "appClipDefaultExperienceLocalizations",
      attributes: attributes,
      relationships: {
        appClipDefaultExperience: {
          data: {
            type: 'appClipDefaultExperiences',
            id: default_experience_id
          }
        }
      }
    }
  }

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

#post_app_clip_header_image(app_clip_default_experience_localization_id: nil, attributes: {}) ⇒ Object



1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1444

def post_app_clip_header_image(app_clip_default_experience_localization_id: nil, attributes: {})
  body = {
    data: {
      type: "appClipHeaderImages",
      attributes: attributes,
      relationships: {
        appClipDefaultExperienceLocalization: {
          data: {
            type: 'appClipDefaultExperienceLocalizations',
            id: app_clip_default_experience_localization_id
          }
        }
      }
    }
  }

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



714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 714

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



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 561

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



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 513

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



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 463

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



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 754

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



929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 929

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



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

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



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

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



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1052

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



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1025

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_beta_app_clip_invocation_localization(beta_app_clip_invocation_id:, attributes:) ⇒ Object



1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1542

def post_beta_app_clip_invocation_localization(beta_app_clip_invocation_id:, attributes:)
  body = {
    data: {
      type: "betaAppClipInvocationLocalizations",
      # required attributes: locale, title
      attributes: attributes,
      relationships: {
        betaAppClipInvocation: {
          data: {
            type: 'betaAppClipInvocations',
            id: beta_app_clip_invocation_id,
          }
        }
      }
    }
  }

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

#post_beta_app_clip_invocations(build_bundle_id:, attributes:, localized_titles:) ⇒ Object



1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1491

def post_beta_app_clip_invocations(build_bundle_id:, attributes:, localized_titles:)
  included = []
  included_ids = []

  localized_titles.each do |localized_title|
    id = "${beta-app-clip-localized-invocation-#{localized_title[:locale]}}"
    included << {
      type: 'betaAppClipInvocationLocalizations',
      id: id,
      attributes: localized_title
    }
    included_ids << id
  end

  body = {
    data: {
      type: "betaAppClipInvocations",
      # required attribute: url
      attributes: attributes,
      relationships: {
        betaAppClipInvocationLocalizations: {
          data: included_ids.map { |id|
            {
              type: 'betaAppClipInvocationLocalizations',
              id: id
            }
          }
        },
        buildBundle: {
          data: {
            type: 'buildBundles',
            id: build_bundle_id,
          }
        }
      }
    },
    included: included
  }

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

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



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

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



1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1079

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



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 993

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



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

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



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

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



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

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

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

#post_webhook(app_id:, enabled:, event_types:, name:, secret:, url:) ⇒ Object



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 1290

def post_webhook(app_id:, enabled:, event_types:, name:, secret:, url:)
  body = {
    data: {
      type: "webhooks",
      attributes: {
        enabled: enabled,
        eventTypes: event_types,
        name: name,
        secret: secret,
        url: url
      },
      relationships: {
        app: {
          data: {
            id: app_id,
            type: "apps"
          }
        }
      }
    }
  }

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