api

May 17, 2024

Changes in this version

type StoreConfig

+ TokenExpiredAtFunc func() int64

+ TokenIssuedAtFunc func() int64

type Token

+ ExpiredAtFunc func() int64

+ IssuedAtFunc func() int64

May 16, 2024

Changes in this version

type StoreConfig

+ TokenExpiredAt int64

+ TokenIssueAt int64

type Token

+ IssueAt int64

Apr 29, 2024

Changes in this version

+ var InvalidTransactionTypeNotSupportedError = newError(4000047, ...)

type ConsumptionRequestBody

+ RefundPreference int32

Oct 30, 2023

Changes in this version

type JWSTransaction

+ Currency string

+ OfferDiscountType OfferDiscountType

+ Price int32

+ type OfferDiscountType string

+ const OfferDiscountTypeFreeTrial

+ const OfferDiscountTypePayAsYouGo

+ const OfferDiscountTypePayUpFront

Oct 25, 2023

Changes in this version

+ var InvalidAccountTenureError = newError(4000032, "Invalid request. The account tenure field is invalid.")

+ var InvalidAppAccountTokenError = newError(4000033, ...)

+ var InvalidConsumptionStatusError = newError(4000034, "Invalid request. The consumption status field is invalid.")

+ var InvalidCustomerConsentedError = newError(4000035, ...)

+ var InvalidDeliveryStatusError = newError(4000036, "Invalid request. The delivery status field is invalid")

+ var InvalidLifetimeDollarsPurchasedError = newError(4000037, "Invalid request. The lifetime dollars purchased field is invalid")

+ var InvalidLifetimeDollarsRefundedError = newError(4000038, "Invalid request. The lifetime dollars refunded field is invalid")

+ var InvalidPlatformError = newError(4000039, "Invalid request. The platform field is invalid")

+ var InvalidPlayTimeError = newError(4000040, "Invalid request. The playtime field is invalid")

+ var InvalidSampleContentProvidedError = newError(4000041, "Invalid request. The sample content provided field is invalid")

+ var InvalidTransactionNotConsumableError = newError(4000043, ...)

+ var InvalidUserStatusError = newError(4000042, "Invalid request. The user status field is invalid")

Sep 19, 2023

Changes in this version

+ type ConsumptionSender interface

+ SendConsumptionInfo func(ctx context.Context, originalTransactionId string, body ConsumptionRequestBody) (statusCode int, err error)

+ type NotificationGetter interface

+ GetAllNotificationHistory func(ctx context.Context, body NotificationHistoryRequest, duration time.Duration) (responses []NotificationHistoryResponseItem, err error)

+ GetNotificationHistory func(ctx context.Context, body NotificationHistoryRequest, paginationToken string) (rsp *NotificationHistoryResponses, err error)

+ GetTestNotificationStatus func(ctx context.Context, testNotificationToken string) (int, []byte, error)

+ type NotificationSender interface

+ SendRequestTestNotification func(ctx context.Context) (int, []byte, error)

+ type StoreAPIClient interface

+ Do func(ctx context.Context, method string, url string, body io.Reader) (int, []byte, error)

+ type SubscriptionExtender interface

+ ExtendSubscriptionRenewalDate func(ctx context.Context, originalTransactionId string, ...) (statusCode int, err error)

+ ExtendSubscriptionRenewalDateForAll func(ctx context.Context, body MassExtendRenewalDateRequest) (statusCode int, err error)

+ type SubscriptionGetter interface

+ GetALLSubscriptionStatuses func(ctx context.Context, originalTransactionId string, query *url.Values) (rsp *StatusResponse, err error)

+ GetRefundHistory func(ctx context.Context, originalTransactionId string) (responses []*RefundLookupResponse, err error)

+ GetSubscriptionRenewalDataStatus func(ctx context.Context, productId, requestIdentifier string) (statusCode int, rsp *MassExtendRenewalDateStatusResponse, err error)

+ GetTransactionHistory func(ctx context.Context, originalTransactionId string, query *url.Values) (responses []*HistoryResponse, err error)

+ GetTransactionInfo func(ctx context.Context, transactionId string) (rsp *TransactionInfoResponse, err error)

+ LookupOrderID func(ctx context.Context, orderId string) (rsp *OrderLookupResponse, err error)

+ type TransactionParser interface

+ ParseJWSEncodeString func(jwsEncode string) (interface{}, error)

+ ParseSignedTransaction func(transaction string) (*JWSTransaction, error)

+ ParseSignedTransactions func(transactions []string) ([]*JWSTransaction, error)

Aug 31, 2023

Changes in this version

+ const AutoRenewStatusOff

+ const AutoRenewStatusOn

+ const SubscriptionActive

+ const SubscriptionExpired

+ const SubscriptionGracePeriod

+ const SubscriptionRetryPeriod

+ const SubscriptionRevoked

+ type AutoRenewStatus int32

+ type AutoRenewSubscriptionStatus int32

Jul 26, 2023

Changes in this version

type JWSRenewalInfoDecodedPayload

+ func (J JWSRenewalInfoDecodedPayload) Valid() error

type StoreClient

+ func (a *StoreClient) ParseJWSEncodeString(jwsEncode string) (interface{}, error)

Jul 3, 2023

Changes in this version

type StoreClient

+ func (a *StoreClient) GetAllNotificationHistory(ctx context.Context, body NotificationHistoryRequest, duration time.Duration) (responses []NotificationHistoryResponseItem, err error)

Jun 29, 2023

Changes in this version

type Error

+ func (e *Error) RetryAfter() int64

Jun 15, 2023

Changes in this version

+ type Environment string

+ const Production

+ const Sandbox

type JWSRenewalInfoDecodedPayload

+ AutoRenewProductId string

+ AutoRenewStatus int32

+ Environment Environment

+ ExpirationIntent int32

+ GracePeriodExpiresDate int64

+ IsInBillingRetryPeriod bool

+ OfferIdentifier string

+ OfferType string

+ OriginalTransactionId string

+ PriceIncreaseStatus int32

+ ProductId string

+ RecentSubscriptionStartDate int64

+ RenewalDate int64

+ SignedDate int64

type JWSTransaction

+ Environment Environment

+ type MassExtendRenewalDateStatusResponse struct

+ Complete bool

+ CompleteDate int64

+ FailedCount int64

+ RequestIdentifier string

+ SucceededCount int64

Jun 15, 2023

Changes in this version

type FirstSendAttemptResult

+ const FirstSendAttemptResultUnsupportedHTTPRESPONSECODE

type NotificationHistoryRequest

+ OnlyFailures bool

+ TransactionId string

type NotificationHistoryResponseItem

+ SendAttempts []SendAttemptItem

+ type SendAttemptItem struct

+ AttemptDate int64

+ SendAttemptResult FirstSendAttemptResult

Jun 13, 2023

Changes in this version

type StoreClient

+ func (a *StoreClient) ParseSignedTransaction(transaction string) (*JWSTransaction, error)

Jun 12, 2023

Changes in this version

+ const TransactionReasonPurchase

+ const TransactionReasonRenewal

+ type IAPType string

+ const AutoRenewable

+ const Consumable

+ const NonConsumable

+ const NonRenewable

type JWSTransaction

+ Storefront string

+ StorefrontId string

+ TransactionReason TransactionReason

+ type TransactionReason string

Jun 7, 2023

Changes in this version

+ var AccountNotFoundError = newError(4040001, "Account not found.")

+ var AccountNotFoundRetryableError = newError(4040002, "Account not found. Please try again.")

+ var AppNotFoundError = newError(4040003, "App not found.")

+ var AppNotFoundRetryableError = newError(4040004, "App not found. Please try again.")

+ var FamilySharedSubscriptionExtensionIneligibleError = newError(4030007, ...)

+ var GeneralBadRequestError = newError(4000000, "Bad request.")

+ var GeneralInternalError = newError(5000000, "An unknown error occurred.")

+ var GeneralInternalRetryableError = newError(5000001, "An unknown error occurred. Please try again.")

+ var InvalidAppIdentifierError = newError(4000002, "Invalid request app identifier.")

+ var InvalidEmptyStorefrontCountryCodeListError = newError(4000027, ...)

+ var InvalidEndDateError = newError(4000016, ...)

+ var InvalidExtendByDaysError = newError(4000009, "Invalid extend by days value.")

+ var InvalidExtendReasonCodeError = newError(4000010, "Invalid extend reason code.")

+ var InvalidInAppOwnershipTypeError = newError(4000026, "Invalid request. The in-app ownership type parameter is invalid.")

+ var InvalidNotificationTypeError = newError(4000018, "Invalid request. The notification type or subtype is invalid.")

+ var InvalidOriginalTransactionIdError = newError(4000008, "Invalid original transaction id.")

+ var InvalidPaginationTokenError = newError(4000014, "Invalid request. The pagination token is invalid.")

+ var InvalidProductIdError = newError(4000023, "Invalid request. The product id parameter is invalid.")

+ var InvalidProductTypeError = newError(4000022, "Invalid request. The product type parameter is invalid.")

+ var InvalidRequestIdentifierError = newError(4000011, "Invalid request identifier.")

+ var InvalidRequestRevisionError = newError(4000005, "Invalid request revision.")

+ var InvalidRevokedError = newError(4000030, "Invalid request. The revoked parameter is invalid.")

+ var InvalidSortError = newError(4000021, "Invalid request. The sort parameter is invalid.")

+ var InvalidStartDateError = newError(4000015, ...)

+ var InvalidStatusError = newError(4000031, "Invalid request. The status parameter is invalid.")

+ var InvalidStorefrontCountryCodeError = newError(4000028, "Invalid request. A storefront country code was invalid.")

+ var InvalidSubscriptionGroupIdentifierError = newError(4000024, ...)

+ var InvalidTestNotificationTokenError = newError(4000020, "Invalid request. The test notification token is invalid.")

+ var InvalidTransactionIdError = newError(4000006, "Invalid transaction id.")

+ var MultipleFiltersSuppliedError = newError(4000019, ...)

+ var OriginalTransactionIdNotFoundError = newError(4040005, "Original transaction id not found.")

+ var OriginalTransactionIdNotFoundRetryableError = newError(4040006, "Original transaction id not found. Please try again.")

+ var PaginationTokenExpiredError = newError(4000017, "Invalid request. The pagination token is expired.")

+ var RateLimitExceededError = newError(4290000, "Rate limit exceeded.")

+ var ServerNotificationURLNotFoundError = newError(4040007, ...)

+ var StartDateAfterEndDateError = newError(4000013, ...)

+ var StartDateTooFarInPastError = newError(4000012, ...)

+ var StatusRequestNotFoundError = newError(4040009, ...)

+ var SubscriptionExtensionIneligibleError = newError(4030004, "Forbidden - subscription state ineligible for extension.")

+ var SubscriptionMaxExtensionError = newError(4030005, "Forbidden - subscription has reached maximum extension count.")

+ var TestNotificationNotFoundError = newError(4040008, ...)

+ var TransactionIdNotFoundError = newError(4040010, "Transaction id not found.")

+ type Error struct

+ func (e *Error) As(target interface{}) bool

+ func (e *Error) Error() string

+ func (e *Error) ErrorCode() int

+ func (e *Error) ErrorMessage() string

+ func (e *Error) Is(target error) bool

+ func (e *Error) Retryable() bool

Jun 6, 2023

Changes in this version

+ const PathExtendSubscriptionRenewalDateForAll

+ const PathGetStatusOfSubscriptionRenewalDate

+ type MassExtendRenewalDateRequest struct

+ ExtendByDays int

+ ExtendReasonCode int

+ ProductId string

+ RequestIdentifier string

+ StorefrontCountryCodes []string

type StoreClient

+ func (a *StoreClient) ExtendSubscriptionRenewalDateForAll(ctx context.Context, body MassExtendRenewalDateRequest) (statusCode int, err error)

+ func (a *StoreClient) GetSubscriptionRenewalDataStatus(ctx context.Context, productId, requestIdentifier string) (statusCode int, err error)

Jun 6, 2023

Changes in this version

+ const PathTransactionInfo

type StoreClient

+ func (a *StoreClient) GetTransactionInfo(ctx context.Context, transactionId string) (rsp *TransactionInfoResponse, err error)

+ type TransactionInfoResponse struct

+ SignedTransactionInfo string

Nov 3, 2022

Changes in this version

+ const CustomerSatisfaction

+ const OtherReasons

+ const PathExtendSubscriptionRenewalDate

+ const PathGetNotificationHistory

+ const PathGetTestNotificationStatus

+ const PathRequestTestNotification

+ const ServiceIssueOrOutage

+ const UndeclaredExtendReasonCode

+ type ExtendReasonCode int

+ type ExtendRenewalDateRequest struct

+ ExtendByDays int

+ ExtendReasonCode ExtendReasonCode

+ RequestIdentifier string

+ type FirstSendAttemptResult string

+ const FirstSendAttemptResultCircularRedirect

+ const FirstSendAttemptResultInvalidResponse

+ const FirstSendAttemptResultNoResponse

+ const FirstSendAttemptResultOther

+ const FirstSendAttemptResultPrematureClose

+ const FirstSendAttemptResultSocketIssue

+ const FirstSendAttemptResultSuccess

+ const FirstSendAttemptResultTimedOut

+ const FirstSendAttemptResultTlsIssue

+ const FirstSendAttemptResultUnsupportedCharset

+ type NotificationHistoryRequest struct

+ EndDate int64

+ NotificationSubtype appstore.SubtypeV2

+ NotificationType appstore.NotificationTypeV2

+ OriginalTransactionId string

+ StartDate int64

+ type NotificationHistoryResponseItem struct

+ FirstSendAttemptResult FirstSendAttemptResult

+ SignedPayload string

+ type NotificationHistoryResponses struct

+ HasMore bool

+ NotificationHistory []NotificationHistoryResponseItem

+ PaginationToken string

+ type SendTestNotificationResponse struct

+ TestNotificationToken string

type StoreClient

+ func NewStoreClientWithHTTPClient(config *StoreConfig, httpClient *http.Client) *StoreClient

+ func (a *StoreClient) ExtendSubscriptionRenewalDate(ctx context.Context, originalTransactionId string, ...) (statusCode int, err error)

+ func (a *StoreClient) GetNotificationHistory(ctx context.Context, body NotificationHistoryRequest) (responses []NotificationHistoryResponseItem, err error)

+ func (a *StoreClient) GetTestNotificationStatus(ctx context.Context, testNotificationToken string) (int, []byte, error)

+ func (a *StoreClient) SendRequestTestNotification(ctx context.Context) (int, []byte, error)

Oct 19, 2022

Changes in this version

+ const PathConsumptionInfo

+ type ConsumptionRequestBody struct

+ AccountTenure int

+ AppAccountToken string

+ ConsumptionStatus int

+ CustomerConsented bool

+ DeliveryStatus int

+ LifetimeDollarsPurchased int

+ LifetimeDollarsRefunded int

+ Platform int

+ PlayTime int

+ SampleContentProvided bool

+ UserStatus int

type JWSTransaction

+ IsUpgraded bool

+ RevocationDate int64

+ RevocationReason int

type StoreClient

+ func (a *StoreClient) SendConsumptionInfo(originalTransactionId string, body ConsumptionRequestBody) (statusCode int, err error)

+ type StoreConfig struct

+ BundleID string

+ Issuer string

+ KeyContent []byte

+ KeyID string

+ Sandbox bool

type Token

+ func (t *Token) WithConfig(c *StoreConfig)

Oct 18, 2022

Changes in this version

+ const HostProduction

+ const HostSandBox

+ const PathGetALLSubscriptionStatus

+ const PathLookUp

+ const PathRefundHistory

+ const PathTransactionHistory

+ var ErrAuthKeyInvalidPem = errors.New("token: AuthKey must be a valid .p8 PEM file")

+ var ErrAuthKeyInvalidType = errors.New("token: AuthKey must be of type ecdsa.PrivateKey")

+ type Cert struct

+ type HistoryResponse struct

+ AppAppleId int

+ BundleId string

+ Environment string

+ HasMore bool

+ Revision string

+ SignedTransactions []string

+ type JWSDecodedHeader struct

+ Alg string

+ Kid string

+ X5C []string

+ type JWSRenewalInfoDecodedPayload struct

+ type JWSTransaction struct

+ AppAccountToken string

+ BundleID string

+ ExpiresDate int64

+ InAppOwnershipType string

+ OfferIdentifier string

+ OfferType int64

+ OriginalPurchaseDate int64

+ OriginalTransactionId string

+ ProductID string

+ PurchaseDate int64

+ Quantity int64

+ SignedDate int64

+ SubscriptionGroupIdentifier string

+ TransactionID string

+ Type string

+ WebOrderLineItemId string

+ func (J JWSTransaction) Valid() error

+ type LastTransactionsItem struct

+ OriginalTransactionId string

+ SignedRenewalInfo string

+ SignedTransactionInfo string

+ Status int

+ type OrderLookupResponse struct

+ SignedTransactions []string

+ Status int

+ type RefundLookupResponse struct

+ HasMore bool

+ Revision string

+ SignedTransactions []string

+ type StatusResponse struct

+ AppAppleId int

+ BundleId string

+ Data []SubscriptionGroupIdentifierItem

+ Environment string

+ type StoreClient struct

+ Token *Token

+ func NewStoreClient(token *Token) *StoreClient

+ func (a *StoreClient) Do(method string, url string, body io.Reader) (int, []byte, error)

+ func (a *StoreClient) GetALLSubscriptionStatuses(originalTransactionId string) (rsp *StatusResponse, err error)

+ func (a *StoreClient) GetRefundHistory(originalTransactionId string) (responses []*RefundLookupResponse, err error)

+ func (a *StoreClient) GetTransactionHistory(originalTransactionId string) (responses []*HistoryResponse, err error)

+ func (a *StoreClient) LookupOrderID(invoiceOrderId string) (rsp *OrderLookupResponse, err error)

+ func (a *StoreClient) ParseSignedTransactions(transactions []string) ([]*JWSTransaction, error)

+ type SubscriptionGroupIdentifierItem struct

+ LastTransactions []LastTransactionsItem

+ SubscriptionGroupIdentifier string

+ type Token struct

+ AuthKey *ecdsa.PrivateKey

+ Bearer string

+ BundleID string

+ ExpiredAt int64

+ Issuer string

+ KeyContent []byte

+ KeyID string

+ Sandbox bool

+ func (t *Token) Expired() bool

+ func (t *Token) Generate() error

+ func (t *Token) GenerateIfExpired() (string, error)