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

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

Instance Method Summary collapse

Instance Method Details

#delete_app_info(app_info_id: nil) ⇒ Object 



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

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

#delete_app_preview(app_preview_id: nil) ⇒ Object 



240
241
242
243
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 240

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

#delete_app_screenshot(app_screenshot_id: nil) ⇒ Object 



439
440
441
442
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 439

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

#delete_app_store_review_attachment(app_store_review_attachment_id: nil) ⇒ Object 



346
347
348
349
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 346

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

#delete_app_store_version_localization(app_store_version_localization_id: nil) ⇒ Object 



672
673
674
675
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 672

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

#delete_app_store_version_phased_release(app_store_version_phased_release_id: nil) ⇒ Object 



705
706
707
708
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 705

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

#delete_app_store_version_submission(app_store_version_submission_id: nil) ⇒ Object 



838
839
840
841
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 838

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

#delete_idfa_declaration(idfa_declaration_id: nil) ⇒ Object 



905
906
907
908
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 905

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

#delete_reset_ratings_request(reset_ratings_request_id: nil) ⇒ Object 



806
807
808
809
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 806

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

#delete_sandbox_tester(sandbox_tester_id: nil) ⇒ Object 



930
931
932
933
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 930

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

#get_age_rating_declaration(app_store_version_id: nil) ⇒ Object

ageRatingDeclarations



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

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

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

appInfoLocalizations



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

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

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

appInfos



448
449
450
451
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 448

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

#get_app_preview(app_preview_id: nil) ⇒ Object

appPreview



204
205
206
207
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 204

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

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



254
255
256
257
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 254

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

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

appPreviewSets



249
250
251
252
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 249

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

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

appPrices



306
307
308
309
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 306

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

#get_app_screenshot(app_screenshot_id: nil) ⇒ Object

appScreenshots



403
404
405
406
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 403

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

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



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

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

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

appScreenshotSets



355
356
357
358
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 355

def get_app_screenshot_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("appScreenshotSets", params)
end

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

appStoreReviewDetails



596
597
598
599
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 596

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

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



719
720
721
722
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 719

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

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

appStoreVersionLocalizations



636
637
638
639
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 636

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

#get_app_store_version_phased_release(app_store_version_id: nil) ⇒ Object

appStoreVersionPhasedReleases



681
682
683
684
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 681

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

#get_app_store_version_submission(app_store_version_id: nil) ⇒ Object

appStoreVersionSubmissions



815
816
817
818
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 815

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

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

appStoreVersions



714
715
716
717
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 714

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

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

availableTerritories



297
298
299
300
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 297

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

#get_idfa_declaration(app_store_version_id: nil) ⇒ Object

idfaDeclarations



869
870
871
872
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 869

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

#get_reset_ratings_request(app_store_version_id: nil) ⇒ Object

appStoreVersionPhasedReleases



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

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

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

sandboxTesters



914
915
916
917
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 914

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

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

territories



939
940
941
942
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 939

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

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



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

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

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

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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 135

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

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

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

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

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

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

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

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



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

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

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

  body = {
    data: data
  }

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

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

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

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




481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 481

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

  relationships = {}

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

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

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

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

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

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

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

  body = {
    data: data
  }

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

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



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_info_localization(app_info_localization_id: nil, attributes: {})
  body = {
    data: {
      type: "appInfoLocalizations",
      id: app_info_localization_id,
      attributes: attributes
    }
  }

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

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



228
229
230
231
232
233
234
235
236
237
238
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 228

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

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

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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 278

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

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

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

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



427
428
429
430
431
432
433
434
435
436
437
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 427

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

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

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



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

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

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

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

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



334
335
336
337
338
339
340
341
342
343
344
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 334

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

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

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



620
621
622
623
624
625
626
627
628
629
630
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 620

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

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

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



743
744
745
746
747
748
749
750
751
752
753
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 743

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

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

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



660
661
662
663
664
665
666
667
668
669
670
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 660

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

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

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



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

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

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

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

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



893
894
895
896
897
898
899
900
901
902
903
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 893

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

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

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

app



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 41

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

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

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

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

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

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

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

  tunes_request_client.post("apps", body)
end

#post_app_info_localization(app_info_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_info_localization(app_info_id: nil, attributes: {})
  body = {
    data: {
      type: "appInfoLocalizations",
      attributes: attributes,
      relationships: {
        appStoreVersion: {
          data: {
            type: "appStoreVersions",
            id: app_info_id
          }
        }
      }
    }
  }

  tunes_request_client.post("appInfoLocalizations", body)
end

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 209

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

  tunes_request_client.post("appPreviews", body)
end

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 259

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

  tunes_request_client.post("appPreviewSets", body)
end

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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 408

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

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

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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 365

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

  tunes_request_client.post("appScreenshotSets", body)
end

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

appReviewAttachments



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 315

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

  tunes_request_client.post("appStoreReviewAttachments", body)
end

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



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 601

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

  tunes_request_client.post("appStoreReviewDetails", body)
end

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



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 724

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

  tunes_request_client.post("appStoreVersions", body)
end

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



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 641

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

  tunes_request_client.post("appStoreVersionLocalizations", body)
end

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



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 686

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

  tunes_request_client.post("appStoreVersionPhasedReleases", body)
end

#post_app_store_version_release_request(app_store_version_id: nil) ⇒ Object

appStoreVersionReleaseRequests



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 847

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

  tunes_request_client.post("appStoreVersionReleaseRequests", body)
end

#post_app_store_version_submission(app_store_version_id: nil) ⇒ Object 



820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 820

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

  tunes_request_client.post("appStoreVersionSubmissions", body)
end

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



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 874

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

  tunes_request_client.post("idfaDeclarations", body)
end

#post_reset_ratings_request(app_store_version_id: nil) ⇒ Object 



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

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

  tunes_request_client.post("resetRatingsRequests", body)
end

#post_sandbox_tester(attributes: {}) ⇒ Object 



919
920
921
922
923
924
925
926
927
928
 
# File 'spaceship/lib/spaceship/connect_api/tunes/tunes.rb', line 919

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

  tunes_request_client.post("sandboxTesters", body)
end

#tunes_request_client ⇒ Object

Raises:

  • (TypeError) 


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

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

#tunes_request_client=(tunes_request_client) ⇒ Object 



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

def tunes_request_client=(tunes_request_client)
  @tunes_request_client = tunes_request_client
end