Class AppStoreServerAPIClient

Constructors

constructor

new AppStoreServerAPIClient(
    signingKey: string,
    keyId: string,
    issuerId: string,
    bundleId: string,
    environment: Environment,
): AppStoreServerAPIClient
Create an App Store Server API client
Parameters
- signingKey: string
  Your private key downloaded from App Store Connect
- keyId: string
  Your private key ID from App Store Connect
- issuerId: string
  Your issuer ID from the Keys page in App Store Connect
- bundleId: string
  Your app’s bundle ID
- environment: Environment
  The environment to target
Returns AppStoreServerAPIClient
- Defined in index.ts:213

Methods

configureDefaultMessage

configureDefaultMessage(
    productId: string,
    locale: string,
    defaultConfigurationRequest: DefaultConfigurationRequest,
): Promise<void>
Configure a default message for a specific product in a specific locale.
Parameters
- productId: string
  The product identifier for the default configuration.
- locale: string
  The locale for the default configuration.
- defaultConfigurationRequest: DefaultConfigurationRequest
  The request body that includes the message identifier to configure as the default message.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed Configure Default Message
- Defined in index.ts:599

configureRealtimeURL

configureRealtimeURL(realtimeUrlRequest: RealtimeUrlRequest): Promise<void>
Configures the URL for your Get Retention Message endpoint in the sandbox and production environments.
Parameters
- realtimeUrlRequest: RealtimeUrlRequest
  The request body that includes your endpoint’s URL.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed Configure Realtime URL
- Defined in index.ts:635

deleteDefaultMessage

deleteDefaultMessage(productId: string, locale: string): Promise<void>
Delete a default message for a product in a locale.
Parameters
- productId: string
  The product ID of the default message configuration.
- locale: string
  The locale of the default message configuration.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed Delete Default Message
- Defined in index.ts:611

deleteImage

deleteImage(imageIdentifier: string): Promise<void>
Delete a previously uploaded image.
Parameters
- imageIdentifier: string
  The identifier of the image to delete.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed Delete Image
- Defined in index.ts:541

deleteMessage

deleteMessage(messageIdentifier: string): Promise<void>
Delete a previously uploaded message.
Parameters
- messageIdentifier: string
  The identifier of the message to delete.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed Delete Message
- Defined in index.ts:575

deleteRealtimeURL

deleteRealtimeURL(): Promise<void>
Deletes the URL for your Get Retention Message endpoint, in the sandbox or production environments.

Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed Delete Realtime URL
- Defined in index.ts:645

extendRenewalDateForAllActiveSubscribers

extendRenewalDateForAllActiveSubscribers(
massExtendRenewalDateRequest: MassExtendRenewalDateRequest,
): Promise<MassExtendRenewalDateResponse>
Uses a subscription’s product identifier to extend the renewal date for all of its eligible active subscribers.
Parameters
- massExtendRenewalDateRequest: MassExtendRenewalDateRequest
  The request body for extending a subscription renewal date for all of its active subscribers.
Returns Promise<MassExtendRenewalDateResponse>
A response that indicates the server successfully received the subscription-renewal-date extension request.

Throws
APIException If a response was returned indicating the request could not be processed Extend Subscription Renewal Dates for All Active Subscribers
- Defined in index.ts:308

extendSubscriptionRenewalDate

extendSubscriptionRenewalDate(
originalTransactionId: string,
extendRenewalDateRequest: ExtendRenewalDateRequest,
): Promise<ExtendRenewalDateResponse>
Extends the renewal date of a customer’s active subscription using the original transaction identifier.
Parameters
- originalTransactionId: string
  The original transaction identifier of the subscription receiving a renewal date extension.
- extendRenewalDateRequest: ExtendRenewalDateRequest
  The request body containing subscription-renewal-extension data.
Returns Promise<ExtendRenewalDateResponse>
A response that indicates whether an individual renewal-date extension succeeded, and related details.

Throws
APIException If a response was returned indicating the request could not be processed Extend a Subscription Renewal Date
- Defined in index.ts:321

finishTransaction

finishTransaction(transactionId: string): Promise<void>
Notifies the App Store server that your system has finished processing the customer's transaction.
Parameters
- transactionId: string
  The transaction identifier of the transaction to mark as finished.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed Finish Transaction
- Defined in index.ts:703

getAllSubscriptionStatuses

getAllSubscriptionStatuses(
anyTransactionId: string,
status?: Status[] | undefined,
): Promise<StatusResponse>
Get the statuses for all of a customer’s auto-renewable subscriptions in your app.
Parameters
- anyTransactionId: string
  Any transactionId, originalTransactionId, or appTransactionId that belongs to the customer for your app.
- status: Status[] | undefined = undefined
  An optional filter that indicates the status of subscriptions to include in the response. Your query may specify more than one status query parameter.
Returns Promise<StatusResponse>
A response that contains status information for all of a customer’s auto-renewable subscriptions in your app.

Throws
APIException If a response was returned indicating the request could not be processed Get All Subscription Statuses
- Defined in index.ts:334

getAppTransactionInfo

getAppTransactionInfo(
anyTransactionId: string,
): Promise<AppTransactionInfoResponse>
Get a customer's app transaction information for your app.
Parameters
- anyTransactionId: string
  Any transactionId, originalTransactionId, or appTransactionId that belongs to the customer for your app.
Returns Promise<AppTransactionInfoResponse>
A response that contains signed app transaction information for a customer.

Throws
APIException If a response was returned indicating the request could not be processed Get App Transaction Info
- Defined in index.ts:692

getDefaultMessage

getDefaultMessage(
productId: string,
locale: string,
): Promise<DefaultConfigurationResponse>
Gets the default message for a specific product in a specific locale, if it’s configured.
Parameters
- productId: string
  The product identifier of the message.
- locale: string
  The locale of the message.
Returns Promise<DefaultConfigurationResponse>
The response body that contains the default configuration information.

Throws
APIException If a response was returned indicating the request could not be processed Get Default Message
- Defined in index.ts:624

getImageList

getImageList(): Promise<GetImageListResponse>
Get the image identifier and state for all uploaded images.

Returns Promise<GetImageListResponse>
A response that contains status information for all images.

Throws
APIException If a response was returned indicating the request could not be processed Get Image List
- Defined in index.ts:552

getMessageList

getMessageList(): Promise<GetMessageListResponse>
Get the message identifier and state of all uploaded messages.

Returns Promise<GetMessageListResponse>
A response that contains status information for all messages.

Throws
APIException If a response was returned indicating the request could not be processed Get Message List
- Defined in index.ts:586

getNotificationHistory

getNotificationHistory(
paginationToken: string | null,
notificationHistoryRequest: NotificationHistoryRequest,
): Promise<NotificationHistoryResponse>
Get a list of notifications that the App Store server attempted to send to your server.
Parameters
- paginationToken: string | null
  An optional token you use to get the next set of up to 20 notification history records. All responses that have more records available include a paginationToken. Omit this parameter the first time you call this endpoint.
- notificationHistoryRequest: NotificationHistoryRequest
  The request body that includes the start and end dates, and optional query constraints.
Returns Promise<NotificationHistoryResponse>
A response that contains the App Store Server Notifications history for your app.

Throws
APIException If a response was returned indicating the request could not be processed Get Notification History
- Defined in index.ts:395

getPerformanceTestResults

getPerformanceTestResults(
requestId: string,
): Promise<PerformanceTestResultResponse>
Gets the results of the performance test for the specified identifier.
Parameters
- requestId: string
  The ID of the performance test to return, which you receive in the PerformanceTestResponse when you call Initiate Performance Test.
Returns Promise<PerformanceTestResultResponse>
An object the API returns that describes the performance test results.

Throws
APIException If a response was returned indicating the request could not be processed Get Performance Test Results
- Defined in index.ts:680

getRealtimeURL

getRealtimeURL(): Promise<RealtimeUrlResponse>
Gets the URL for real-time messages that points to your Get Retention Message endpoint, which you previously configured.

Returns Promise<RealtimeUrlResponse>
The response body that contains the URL for your Get Retention Message endpoint.

Throws
APIException If a response was returned indicating the request could not be processed Get Realtime URL
- Defined in index.ts:656

getRefundHistory

getRefundHistory(
anyTransactionId: string,
revision: string | null,
): Promise<RefundHistoryResponse>
Get a paginated list of all of a customer’s refunded in-app purchases for your app.
Parameters
- anyTransactionId: string
  Any transactionId, originalTransactionId, or appTransactionId that belongs to the customer for your app.
- revision: string | null
  A token you provide to get the next set of up to 20 transactions. All responses include a revision token. Use the revision token from the previous RefundHistoryResponse.
Returns Promise<RefundHistoryResponse>
A response that contains status information for all of a customer’s auto-renewable subscriptions in your app.

Throws
APIException If a response was returned indicating the request could not be processed Get Refund History
- Defined in index.ts:352

getStatusOfSubscriptionRenewalDateExtensions

getStatusOfSubscriptionRenewalDateExtensions(
requestIdentifier: string,
productId: string,
): Promise<MassExtendRenewalDateStatusResponse>
Checks whether a renewal date extension request completed, and provides the final count of successful or failed extensions.
Parameters
- requestIdentifier: string
  The UUID that represents your request to the Extend Subscription Renewal Dates for All Active Subscribers endpoint.
- productId: string
  The product identifier of the auto-renewable subscription that you request a renewal-date extension for.
Returns Promise<MassExtendRenewalDateStatusResponse>
A response that indicates the current status of a request to extend the subscription renewal date to all eligible subscribers.

Throws
APIException If a response was returned indicating the request could not be processed Get Status of Subscription Renewal Date Extensions
- Defined in index.ts:370

getTestNotificationStatus

getTestNotificationStatus(
testNotificationToken: string,
): Promise<CheckTestNotificationResponse>
Check the status of the test App Store server notification sent to your server.
Parameters
- testNotificationToken: string
  The test notification token received from the Request a Test Notification endpoint
Returns Promise<CheckTestNotificationResponse>
A response that contains the contents of the test notification sent by the App Store server and the result from your server.

Throws
APIException If a response was returned indicating the request could not be processed Get Test Notification Status
- Defined in index.ts:382

getTransactionHistory

getTransactionHistory(
    anyTransactionId: string,
    revision: string | null,
    transactionHistoryRequest: TransactionHistoryRequest,
    version?: GetTransactionHistoryVersion,
): Promise<HistoryResponse>
Get a customer’s in-app purchase transaction history for your app.
Parameters
- anyTransactionId: string
  Any transactionId, originalTransactionId, or appTransactionId that belongs to the customer for your app.
- revision: string | null
  A token you provide to get the next set of up to 20 transactions. All responses include a revision token. Note: For requests that use the revision token, include the same query parameters from the initial request. Use the revision token from the previous HistoryResponse.
- transactionHistoryRequest: TransactionHistoryRequest
- version: GetTransactionHistoryVersion = GetTransactionHistoryVersion.V1
  The version of the Get Transaction History endpoint to use. V2 is recommended.
Returns Promise<HistoryResponse>
A response that contains the customer’s transaction history for an app.

Throws
APIException If a response was returned indicating the request could not be processed Get Transaction History
- Defined in index.ts:413

getTransactionInfo

getTransactionInfo(transactionId: string): Promise<TransactionInfoResponse>
Get information about a single transaction for your app.
Parameters
- transactionId: string
  The identifier of a transaction that belongs to the customer, and which may be an original transaction identifier.
Returns Promise<TransactionInfoResponse>
A response that contains signed transaction information for a single transaction.

Throws
APIException If a response was returned indicating the request could not be processed Get Transaction Info
- Defined in index.ts:453

initiatePerformanceTest

initiatePerformanceTest(
performanceTestRequest: PerformanceTestRequest,
): Promise<PerformanceTestResponse>
Initiates a performance test of your Get Retention Message endpoint in the sandbox environment.
Parameters
- performanceTestRequest: PerformanceTestRequest
  The request body which specifies a transaction identifier of an In-App Purchase to use for this test.
Returns Promise<PerformanceTestResponse>
The performance test response object.

Throws
APIException If a response was returned indicating the request could not be processed Initiate Performance Test
- Defined in index.ts:668

lookUpOrderId

lookUpOrderId(orderId: string): Promise<OrderLookupResponse>
Get a customer’s in-app purchases from a receipt using the order ID.
Parameters
- orderId: string
  The order ID for in-app purchases that belong to the customer.
Returns Promise<OrderLookupResponse>
A response that includes the order lookup status and an array of signed transactions for the in-app purchases in the order.

Throws
APIException If a response was returned indicating the request could not be processed Look Up Order ID
- Defined in index.ts:465

`Protected`makeFetchRequest

makeFetchRequest(
    path: string,
    parsedQueryParameters: URLSearchParams,
    method: string,
    requestBody: string | Buffer<ArrayBufferLike> | undefined,
    headers: { [key: string]: string },
): Promise<Response>
Parameters
- path: string
- parsedQueryParameters: URLSearchParams
- method: string
- requestBody: string | Buffer<ArrayBufferLike> | undefined
- headers: { [key: string]: string }
Returns Promise<Response>
- Defined in index.ts:292

`Protected`makeRequest

makeRequest<T>(
    path: string,
    method: string,
    queryParameters: { [key: string]: string[] },
    body: object | Buffer<ArrayBufferLike> | null,
    validator: Validator<T> | null,
    contentType?: string,
): Promise<T>
Type Parameters
- T
Parameters
- path: string
- method: string
- queryParameters: { [key: string]: string[] }
- body: object | Buffer<ArrayBufferLike> | null
- validator: Validator<T> | null
- OptionalcontentType: string
Returns Promise<T>
- Defined in index.ts:233

requestTestNotification

requestTestNotification(): Promise<SendTestNotificationResponse>
Ask App Store Server Notifications to send a test notification to your server.

Returns Promise<SendTestNotificationResponse>
A response that contains the test notification token.

Throws
APIException If a response was returned indicating the request could not be processed Request a Test Notification
- Defined in index.ts:476

sendConsumptionData

sendConsumptionData(
transactionId: string,
consumptionRequest: ConsumptionRequestV1,
): Promise<void>
Send consumption information about a consumable in-app purchase to the App Store after your server receives a consumption request notification.
Parameters
- transactionId: string
  The transaction identifier for which you're providing consumption information. You receive this identifier in the CONSUMPTION_REQUEST notification the App Store sends to your server.
- consumptionRequest: ConsumptionRequestV1
  The request body containing consumption information.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed

Deprecated
Use sendConsumptionInformation instead Send Consumption Information
- Defined in index.ts:489

sendConsumptionInformation

sendConsumptionInformation(
transactionId: string,
consumptionRequest: ConsumptionRequest,
): Promise<void>
Send consumption information about an In-App Purchase to the App Store after your server receives a consumption request notification.
Parameters
- transactionId: string
  The transaction identifier for which you're providing consumption information. You receive this identifier in the CONSUMPTION_REQUEST notification the App Store sends to your server's App Store Server Notifications V2 endpoint.
- consumptionRequest: ConsumptionRequest
  The request body containing consumption information.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed Send Consumption Information
- Defined in index.ts:501

setAppAccountToken

setAppAccountToken(
originalTransactionId: string,
updateAppAccountTokenRequest: UpdateAppAccountTokenRequest,
): Promise<void>
Sets the app account token value for a purchase the customer makes outside your app, or updates its value in an existing transaction.
Parameters
- originalTransactionId: string
  The original transaction identifier of the transaction to receive the app account token update.
- updateAppAccountTokenRequest: UpdateAppAccountTokenRequest
  The request body that contains a valid app account token value.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed. Set App Account Token
- Defined in index.ts:513

uploadImage

uploadImage(
    imageIdentifier: string,
    image: Buffer,
    imageSize?: string,
): Promise<void>
Upload an image to use for retention messaging.
Parameters
- imageIdentifier: string
  A UUID you provide to uniquely identify the image you upload. Must be lowercase.
- image: Buffer
  The image file to upload.
- OptionalimageSize: string
  The size of the image you upload.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed Upload Image
- Defined in index.ts:526

uploadMessage

uploadMessage(
messageIdentifier: string,
uploadMessageRequestBody: UploadMessageRequestBody,
): Promise<void>
Upload a message to use for retention messaging.
Parameters
- messageIdentifier: string
  A UUID you provide to uniquely identify the message you upload. Must be lowercase.
- uploadMessageRequestBody: UploadMessageRequestBody
  The message text to upload.
Returns Promise<void>
Throws
APIException If a response was returned indicating the request could not be processed Upload Message
- Defined in index.ts:564

Class AppStoreServerAPIClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AppStoreServerAPIClient

Methods

configureDefaultMessage

Parameters

Returns Promise<void>

Throws

configureRealtimeURL

Parameters

Returns Promise<void>

Throws

deleteDefaultMessage

Parameters

Returns Promise<void>

Throws

deleteImage

Parameters

Returns Promise<void>

Throws

deleteMessage

Parameters

Returns Promise<void>

Throws

deleteRealtimeURL

Returns Promise<void>

Throws

extendRenewalDateForAllActiveSubscribers

Parameters

Returns Promise<MassExtendRenewalDateResponse>

Throws

extendSubscriptionRenewalDate

Parameters

Returns Promise<ExtendRenewalDateResponse>

Throws

finishTransaction

Parameters

Returns Promise<void>

Throws

getAllSubscriptionStatuses

Parameters

Returns Promise<StatusResponse>

Throws

getAppTransactionInfo

Parameters

Returns Promise<AppTransactionInfoResponse>

Throws

getDefaultMessage

Parameters

Returns Promise<DefaultConfigurationResponse>

Throws

getImageList

Returns Promise<GetImageListResponse>

Throws

getMessageList

Returns Promise<GetMessageListResponse>

Throws

getNotificationHistory

Parameters

Returns Promise<NotificationHistoryResponse>

Throws

getPerformanceTestResults

Parameters

Returns Promise<PerformanceTestResultResponse>

Throws

getRealtimeURL

Returns Promise<RealtimeUrlResponse>

Throws

getRefundHistory

Parameters

Returns Promise<RefundHistoryResponse>

Throws

getStatusOfSubscriptionRenewalDateExtensions

Parameters

Returns Promise<MassExtendRenewalDateStatusResponse>

`Protected`makeFetchRequest

`Protected`makeRequest