Skip to content

Files

Latest commit

author
Bohdan Krokhmaliuk
v2.0
Jul 29, 2022
34b1f58 · Jul 29, 2022

History

History
589 lines (419 loc) · 34 KB

InAppPurchasesApi.md

File metadata and controls

589 lines (419 loc) · 34 KB

app_store_connect.api.InAppPurchasesApi

Load the API package

import 'package:app_store_connect/api.dart';

All URIs are relative to https://api.appstoreconnect.apple.com

Method HTTP request Description
inAppPurchasesAppStoreReviewScreenshotGetToOneRelated GET /v2/inAppPurchases/{id}/appStoreReviewScreenshot
inAppPurchasesContentGetToOneRelated GET /v2/inAppPurchases/{id}/content
inAppPurchasesCreateInstance POST /v2/inAppPurchases
inAppPurchasesDeleteInstance DELETE /v2/inAppPurchases/{id}
inAppPurchasesGetInstance GET /v1/inAppPurchases/{id}
inAppPurchasesGetInstance_0 GET /v2/inAppPurchases/{id}
inAppPurchasesIapPriceScheduleGetToOneRelated GET /v2/inAppPurchases/{id}/iapPriceSchedule
inAppPurchasesInAppPurchaseLocalizationsGetToManyRelated GET /v2/inAppPurchases/{id}/inAppPurchaseLocalizations
inAppPurchasesPricePointsGetToManyRelated GET /v2/inAppPurchases/{id}/pricePoints
inAppPurchasesPromotedPurchaseGetToOneRelated GET /v2/inAppPurchases/{id}/promotedPurchase
inAppPurchasesUpdateInstance PATCH /v2/inAppPurchases/{id}

inAppPurchasesAppStoreReviewScreenshotGetToOneRelated

InAppPurchaseAppStoreReviewScreenshotResponse inAppPurchasesAppStoreReviewScreenshotGetToOneRelated(id, fieldsLeftSquareBracketInAppPurchaseAppStoreReviewScreenshotsRightSquareBracket, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, include)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketInAppPurchaseAppStoreReviewScreenshotsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchaseAppStoreReviewScreenshots
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchases
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.inAppPurchasesAppStoreReviewScreenshotGetToOneRelated(id, fieldsLeftSquareBracketInAppPurchaseAppStoreReviewScreenshotsRightSquareBracket, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesAppStoreReviewScreenshotGetToOneRelated: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketInAppPurchaseAppStoreReviewScreenshotsRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchaseAppStoreReviewScreenshots [optional]
fieldsLeftSquareBracketInAppPurchasesRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchases [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

InAppPurchaseAppStoreReviewScreenshotResponse

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inAppPurchasesContentGetToOneRelated

InAppPurchaseContentResponse inAppPurchasesContentGetToOneRelated(id, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, fieldsLeftSquareBracketInAppPurchaseContentsRightSquareBracket, include)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchases
final BuiltList<String> fieldsLeftSquareBracketInAppPurchaseContentsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchaseContents
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.inAppPurchasesContentGetToOneRelated(id, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, fieldsLeftSquareBracketInAppPurchaseContentsRightSquareBracket, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesContentGetToOneRelated: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketInAppPurchasesRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchases [optional]
fieldsLeftSquareBracketInAppPurchaseContentsRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchaseContents [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

InAppPurchaseContentResponse

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inAppPurchasesCreateInstance

InAppPurchaseV2Response inAppPurchasesCreateInstance(inAppPurchaseV2CreateRequest)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final InAppPurchaseV2CreateRequest inAppPurchaseV2CreateRequest = ; // InAppPurchaseV2CreateRequest | InAppPurchase representation

try {
    final response = api.inAppPurchasesCreateInstance(inAppPurchaseV2CreateRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesCreateInstance: $e\n');
}

Parameters

Name Type Description Notes
inAppPurchaseV2CreateRequest InAppPurchaseV2CreateRequest InAppPurchase representation

Return type

InAppPurchaseV2Response

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inAppPurchasesDeleteInstance

inAppPurchasesDeleteInstance(id)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final String id = id_example; // String | the id of the requested resource

try {
    api.inAppPurchasesDeleteInstance(id);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesDeleteInstance: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource

Return type

void (empty response body)

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inAppPurchasesGetInstance

InAppPurchaseResponse inAppPurchasesGetInstance(id, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, include, limitLeftSquareBracketAppsRightSquareBracket)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchases
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final int limitLeftSquareBracketAppsRightSquareBracket = 56; // int | maximum number of related apps returned (when they are included)

try {
    final response = api.inAppPurchasesGetInstance(id, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, include, limitLeftSquareBracketAppsRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesGetInstance: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketInAppPurchasesRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchases [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]
limitLeftSquareBracketAppsRightSquareBracket int maximum number of related apps returned (when they are included) [optional]

Return type

InAppPurchaseResponse

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inAppPurchasesGetInstance_0

InAppPurchaseV2Response inAppPurchasesGetInstance_0(id, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, include, fieldsLeftSquareBracketInAppPurchaseAppStoreReviewScreenshotsRightSquareBracket, fieldsLeftSquareBracketPromotedPurchasesRightSquareBracket, fieldsLeftSquareBracketInAppPurchasePricePointsRightSquareBracket, fieldsLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket, fieldsLeftSquareBracketInAppPurchasePriceSchedulesRightSquareBracket, fieldsLeftSquareBracketInAppPurchaseContentsRightSquareBracket, limitLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket, limitLeftSquareBracketPricePointsRightSquareBracket)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchases
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include
final BuiltList<String> fieldsLeftSquareBracketInAppPurchaseAppStoreReviewScreenshotsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchaseAppStoreReviewScreenshots
final BuiltList<String> fieldsLeftSquareBracketPromotedPurchasesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type promotedPurchases
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasePricePointsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchasePricePoints
final BuiltList<String> fieldsLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchaseLocalizations
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasePriceSchedulesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchasePriceSchedules
final BuiltList<String> fieldsLeftSquareBracketInAppPurchaseContentsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchaseContents
final int limitLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket = 56; // int | maximum number of related inAppPurchaseLocalizations returned (when they are included)
final int limitLeftSquareBracketPricePointsRightSquareBracket = 56; // int | maximum number of related pricePoints returned (when they are included)

try {
    final response = api.inAppPurchasesGetInstance_0(id, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, include, fieldsLeftSquareBracketInAppPurchaseAppStoreReviewScreenshotsRightSquareBracket, fieldsLeftSquareBracketPromotedPurchasesRightSquareBracket, fieldsLeftSquareBracketInAppPurchasePricePointsRightSquareBracket, fieldsLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket, fieldsLeftSquareBracketInAppPurchasePriceSchedulesRightSquareBracket, fieldsLeftSquareBracketInAppPurchaseContentsRightSquareBracket, limitLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket, limitLeftSquareBracketPricePointsRightSquareBracket);
    print(response);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesGetInstance_0: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketInAppPurchasesRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchases [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]
fieldsLeftSquareBracketInAppPurchaseAppStoreReviewScreenshotsRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchaseAppStoreReviewScreenshots [optional]
fieldsLeftSquareBracketPromotedPurchasesRightSquareBracket BuiltList<String> the fields to include for returned resources of type promotedPurchases [optional]
fieldsLeftSquareBracketInAppPurchasePricePointsRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchasePricePoints [optional]
fieldsLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchaseLocalizations [optional]
fieldsLeftSquareBracketInAppPurchasePriceSchedulesRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchasePriceSchedules [optional]
fieldsLeftSquareBracketInAppPurchaseContentsRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchaseContents [optional]
limitLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket int maximum number of related inAppPurchaseLocalizations returned (when they are included) [optional]
limitLeftSquareBracketPricePointsRightSquareBracket int maximum number of related pricePoints returned (when they are included) [optional]

Return type

InAppPurchaseV2Response

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inAppPurchasesIapPriceScheduleGetToOneRelated

InAppPurchasePriceScheduleResponse inAppPurchasesIapPriceScheduleGetToOneRelated(id, fieldsLeftSquareBracketInAppPurchasePricesRightSquareBracket, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, fieldsLeftSquareBracketInAppPurchasePriceSchedulesRightSquareBracket, limitLeftSquareBracketManualPricesRightSquareBracket, include)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasePricesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchasePrices
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchases
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasePriceSchedulesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchasePriceSchedules
final int limitLeftSquareBracketManualPricesRightSquareBracket = 56; // int | maximum number of related manualPrices returned (when they are included)
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.inAppPurchasesIapPriceScheduleGetToOneRelated(id, fieldsLeftSquareBracketInAppPurchasePricesRightSquareBracket, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, fieldsLeftSquareBracketInAppPurchasePriceSchedulesRightSquareBracket, limitLeftSquareBracketManualPricesRightSquareBracket, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesIapPriceScheduleGetToOneRelated: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketInAppPurchasePricesRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchasePrices [optional]
fieldsLeftSquareBracketInAppPurchasesRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchases [optional]
fieldsLeftSquareBracketInAppPurchasePriceSchedulesRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchasePriceSchedules [optional]
limitLeftSquareBracketManualPricesRightSquareBracket int maximum number of related manualPrices returned (when they are included) [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

InAppPurchasePriceScheduleResponse

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inAppPurchasesInAppPurchaseLocalizationsGetToManyRelated

InAppPurchaseLocalizationsResponse inAppPurchasesInAppPurchaseLocalizationsGetToManyRelated(id, fieldsLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, limit, include)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchaseLocalizations
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchases
final int limit = 56; // int | maximum resources per page
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.inAppPurchasesInAppPurchaseLocalizationsGetToManyRelated(id, fieldsLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, limit, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesInAppPurchaseLocalizationsGetToManyRelated: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketInAppPurchaseLocalizationsRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchaseLocalizations [optional]
fieldsLeftSquareBracketInAppPurchasesRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchases [optional]
limit int maximum resources per page [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

InAppPurchaseLocalizationsResponse

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inAppPurchasesPricePointsGetToManyRelated

InAppPurchasePricePointsResponse inAppPurchasesPricePointsGetToManyRelated(id, filterLeftSquareBracketPriceTierRightSquareBracket, filterLeftSquareBracketTerritoryRightSquareBracket, fieldsLeftSquareBracketInAppPurchasePricePointsRightSquareBracket, fieldsLeftSquareBracketTerritoriesRightSquareBracket, limit, include)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> filterLeftSquareBracketPriceTierRightSquareBracket = ; // BuiltList<String> | filter by attribute 'priceTier'
final BuiltList<String> filterLeftSquareBracketTerritoryRightSquareBracket = ; // BuiltList<String> | filter by id(s) of related 'territory'
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasePricePointsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchasePricePoints
final BuiltList<String> fieldsLeftSquareBracketTerritoriesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type territories
final int limit = 56; // int | maximum resources per page
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.inAppPurchasesPricePointsGetToManyRelated(id, filterLeftSquareBracketPriceTierRightSquareBracket, filterLeftSquareBracketTerritoryRightSquareBracket, fieldsLeftSquareBracketInAppPurchasePricePointsRightSquareBracket, fieldsLeftSquareBracketTerritoriesRightSquareBracket, limit, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesPricePointsGetToManyRelated: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
filterLeftSquareBracketPriceTierRightSquareBracket BuiltList<String> filter by attribute 'priceTier' [optional]
filterLeftSquareBracketTerritoryRightSquareBracket BuiltList<String> filter by id(s) of related 'territory' [optional]
fieldsLeftSquareBracketInAppPurchasePricePointsRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchasePricePoints [optional]
fieldsLeftSquareBracketTerritoriesRightSquareBracket BuiltList<String> the fields to include for returned resources of type territories [optional]
limit int maximum resources per page [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

InAppPurchasePricePointsResponse

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inAppPurchasesPromotedPurchaseGetToOneRelated

PromotedPurchaseResponse inAppPurchasesPromotedPurchaseGetToOneRelated(id, fieldsLeftSquareBracketPromotedPurchasesRightSquareBracket, fieldsLeftSquareBracketSubscriptionsRightSquareBracket, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, fieldsLeftSquareBracketPromotedPurchaseImagesRightSquareBracket, limitLeftSquareBracketPromotionImagesRightSquareBracket, include)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final String id = id_example; // String | the id of the requested resource
final BuiltList<String> fieldsLeftSquareBracketPromotedPurchasesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type promotedPurchases
final BuiltList<String> fieldsLeftSquareBracketSubscriptionsRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type subscriptions
final BuiltList<String> fieldsLeftSquareBracketInAppPurchasesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type inAppPurchases
final BuiltList<String> fieldsLeftSquareBracketPromotedPurchaseImagesRightSquareBracket = ; // BuiltList<String> | the fields to include for returned resources of type promotedPurchaseImages
final int limitLeftSquareBracketPromotionImagesRightSquareBracket = 56; // int | maximum number of related promotionImages returned (when they are included)
final BuiltList<String> include = ; // BuiltList<String> | comma-separated list of relationships to include

try {
    final response = api.inAppPurchasesPromotedPurchaseGetToOneRelated(id, fieldsLeftSquareBracketPromotedPurchasesRightSquareBracket, fieldsLeftSquareBracketSubscriptionsRightSquareBracket, fieldsLeftSquareBracketInAppPurchasesRightSquareBracket, fieldsLeftSquareBracketPromotedPurchaseImagesRightSquareBracket, limitLeftSquareBracketPromotionImagesRightSquareBracket, include);
    print(response);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesPromotedPurchaseGetToOneRelated: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsLeftSquareBracketPromotedPurchasesRightSquareBracket BuiltList<String> the fields to include for returned resources of type promotedPurchases [optional]
fieldsLeftSquareBracketSubscriptionsRightSquareBracket BuiltList<String> the fields to include for returned resources of type subscriptions [optional]
fieldsLeftSquareBracketInAppPurchasesRightSquareBracket BuiltList<String> the fields to include for returned resources of type inAppPurchases [optional]
fieldsLeftSquareBracketPromotedPurchaseImagesRightSquareBracket BuiltList<String> the fields to include for returned resources of type promotedPurchaseImages [optional]
limitLeftSquareBracketPromotionImagesRightSquareBracket int maximum number of related promotionImages returned (when they are included) [optional]
include BuiltList<String> comma-separated list of relationships to include [optional]

Return type

PromotedPurchaseResponse

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inAppPurchasesUpdateInstance

InAppPurchaseV2Response inAppPurchasesUpdateInstance(id, inAppPurchaseV2UpdateRequest)

Example

import 'package:app_store_connect/api.dart';
// TODO Configure HTTP basic authorization: itc-bearer-token
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('itc-bearer-token').password = 'YOUR_PASSWORD';

final api = AppStoreConnect().getInAppPurchasesApi();
final String id = id_example; // String | the id of the requested resource
final InAppPurchaseV2UpdateRequest inAppPurchaseV2UpdateRequest = ; // InAppPurchaseV2UpdateRequest | InAppPurchase representation

try {
    final response = api.inAppPurchasesUpdateInstance(id, inAppPurchaseV2UpdateRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling InAppPurchasesApi->inAppPurchasesUpdateInstance: $e\n');
}

Parameters

Name Type Description Notes
id String the id of the requested resource
inAppPurchaseV2UpdateRequest InAppPurchaseV2UpdateRequest InAppPurchase representation

Return type

InAppPurchaseV2Response

Authorization

itc-bearer-token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]