Skip to content

Latest commit

 

History

History
282 lines (198 loc) · 12.6 KB

AppPricePointsAPI.md

File metadata and controls

282 lines (198 loc) · 12.6 KB
Raw

AppPricePointsAPI

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

Method HTTP request Description
appPricePointsGetCollection GET /v1/appPricePoints
appPricePointsGetInstance GET /v1/appPricePoints/{id}
appPricePointsTerritoryGetToOneRelated GET /v1/appPricePoints/{id}/territory
appPricePointsV3EqualizationsGetToManyRelated GET /v3/appPricePoints/{id}/equalizations
appPricePointsV3GetInstance GET /v3/appPricePoints/{id}

appPricePointsGetCollection

    open class func appPricePointsGetCollection(filterPriceTier: [String]? = nil, filterTerritory: [String]? = nil, fieldsAppPricePoints: [FieldsAppPricePoints_appPricePointsGetCollection]? = nil, limit: Int? = nil, include: [Include_appPricePointsGetCollection]? = nil, fieldsTerritories: [FieldsTerritories_appPricePointsGetCollection]? = nil, completion: @escaping (_ data: AppPricePointsResponse?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ASC

let filterPriceTier = ["inner_example"] // [String] | filter by id(s) of related 'priceTier' (optional)
let filterTerritory = ["inner_example"] // [String] | filter by id(s) of related 'territory' (optional)
let fieldsAppPricePoints = ["fieldsAppPricePoints_example"] // [String] | the fields to include for returned resources of type appPricePoints (optional)
let limit = 987 // Int | maximum resources per page (optional)
let include = ["include_example"] // [String] | comma-separated list of relationships to include (optional)
let fieldsTerritories = ["fieldsTerritories_example"] // [String] | the fields to include for returned resources of type territories (optional)

AppPricePointsAPI.appPricePointsGetCollection(filterPriceTier: filterPriceTier, filterTerritory: filterTerritory, fieldsAppPricePoints: fieldsAppPricePoints, limit: limit, include: include, fieldsTerritories: fieldsTerritories) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
filterPriceTier [String] filter by id(s) of related 'priceTier' [optional]
filterTerritory [String] filter by id(s) of related 'territory' [optional]
fieldsAppPricePoints [String] the fields to include for returned resources of type appPricePoints [optional]
limit Int maximum resources per page [optional]
include [String] comma-separated list of relationships to include [optional]
fieldsTerritories [String] the fields to include for returned resources of type territories [optional]

Return type

AppPricePointsResponse

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]

appPricePointsGetInstance

    open class func appPricePointsGetInstance(id: String, fieldsAppPricePoints: [FieldsAppPricePoints_appPricePointsGetInstance]? = nil, include: [Include_appPricePointsGetInstance]? = nil, fieldsTerritories: [FieldsTerritories_appPricePointsGetInstance]? = nil, completion: @escaping (_ data: AppPricePointResponse?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ASC

let id = "id_example" // String | the id of the requested resource
let fieldsAppPricePoints = ["fieldsAppPricePoints_example"] // [String] | the fields to include for returned resources of type appPricePoints (optional)
let include = ["include_example"] // [String] | comma-separated list of relationships to include (optional)
let fieldsTerritories = ["fieldsTerritories_example"] // [String] | the fields to include for returned resources of type territories (optional)

AppPricePointsAPI.appPricePointsGetInstance(id: id, fieldsAppPricePoints: fieldsAppPricePoints, include: include, fieldsTerritories: fieldsTerritories) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsAppPricePoints [String] the fields to include for returned resources of type appPricePoints [optional]
include [String] comma-separated list of relationships to include [optional]
fieldsTerritories [String] the fields to include for returned resources of type territories [optional]

Return type

AppPricePointResponse

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]

appPricePointsTerritoryGetToOneRelated

    open class func appPricePointsTerritoryGetToOneRelated(id: String, fieldsTerritories: [FieldsTerritories_appPricePointsTerritoryGetToOneRelated]? = nil, completion: @escaping (_ data: TerritoryResponse?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ASC

let id = "id_example" // String | the id of the requested resource
let fieldsTerritories = ["fieldsTerritories_example"] // [String] | the fields to include for returned resources of type territories (optional)

AppPricePointsAPI.appPricePointsTerritoryGetToOneRelated(id: id, fieldsTerritories: fieldsTerritories) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsTerritories [String] the fields to include for returned resources of type territories [optional]

Return type

TerritoryResponse

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]

appPricePointsV3EqualizationsGetToManyRelated

    open class func appPricePointsV3EqualizationsGetToManyRelated(id: String, filterTerritory: [String]? = nil, fieldsAppPricePoints: [FieldsAppPricePoints_appPricePointsV3EqualizationsGetToManyRelated]? = nil, fieldsApps: [FieldsApps_appPricePointsV3EqualizationsGetToManyRelated]? = nil, fieldsTerritories: [FieldsTerritories_appPricePointsV3EqualizationsGetToManyRelated]? = nil, limit: Int? = nil, include: [Include_appPricePointsV3EqualizationsGetToManyRelated]? = nil, completion: @escaping (_ data: AppPricePointsV3Response?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ASC

let id = "id_example" // String | the id of the requested resource
let filterTerritory = ["inner_example"] // [String] | filter by id(s) of related 'territory' (optional)
let fieldsAppPricePoints = ["fieldsAppPricePoints_example"] // [String] | the fields to include for returned resources of type appPricePoints (optional)
let fieldsApps = ["fieldsApps_example"] // [String] | the fields to include for returned resources of type apps (optional)
let fieldsTerritories = ["fieldsTerritories_example"] // [String] | the fields to include for returned resources of type territories (optional)
let limit = 987 // Int | maximum resources per page (optional)
let include = ["include_example"] // [String] | comma-separated list of relationships to include (optional)

AppPricePointsAPI.appPricePointsV3EqualizationsGetToManyRelated(id: id, filterTerritory: filterTerritory, fieldsAppPricePoints: fieldsAppPricePoints, fieldsApps: fieldsApps, fieldsTerritories: fieldsTerritories, limit: limit, include: include) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id String the id of the requested resource
filterTerritory [String] filter by id(s) of related 'territory' [optional]
fieldsAppPricePoints [String] the fields to include for returned resources of type appPricePoints [optional]
fieldsApps [String] the fields to include for returned resources of type apps [optional]
fieldsTerritories [String] the fields to include for returned resources of type territories [optional]
limit Int maximum resources per page [optional]
include [String] comma-separated list of relationships to include [optional]

Return type

AppPricePointsV3Response

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]

appPricePointsV3GetInstance

    open class func appPricePointsV3GetInstance(id: String, fieldsAppPricePoints: [FieldsAppPricePoints_appPricePointsV3GetInstance]? = nil, include: [Include_appPricePointsV3GetInstance]? = nil, completion: @escaping (_ data: AppPricePointV3Response?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ASC

let id = "id_example" // String | the id of the requested resource
let fieldsAppPricePoints = ["fieldsAppPricePoints_example"] // [String] | the fields to include for returned resources of type appPricePoints (optional)
let include = ["include_example"] // [String] | comma-separated list of relationships to include (optional)

AppPricePointsAPI.appPricePointsV3GetInstance(id: id, fieldsAppPricePoints: fieldsAppPricePoints, include: include) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id String the id of the requested resource
fieldsAppPricePoints [String] the fields to include for returned resources of type appPricePoints [optional]
include [String] comma-separated list of relationships to include [optional]

Return type

AppPricePointV3Response

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]