@skalpgg/sdk 1.5.0 → 1.6.0

package/README.md

@@ -43,9 +43,10 @@ Create the key on the API keys page of your dashboard. Each key is bound to one
 | --- | --- |
 | `checkout.create({ productId, quantity?, customerEmail?, metadata?, couponCode?, returnUrl?, customFields? })` | `checkout:write` |
 | `checkout.get(id)` | `checkout:read` |
-| `orders.list({ status?, productId?, email?, createdAfter?, createdBefore?, updatedSince?, limit?, offset? })` | `orders:read` |
+| `orders.list({ status?, productId?, email?, identifier?, createdAfter?, createdBefore?, updatedSince?, limit?, offset? })` | `orders:read` |
 | `orders.get(id)` | `orders:read` |
 | `orders.cancel(id)` | `orders:write` |
+| `orders.redeliver(id)` | `orders:write` |
 | `orders.replace(id, { serialIds?, values?, reason? })` | `orders:write` |
 | `products.list({ status?, limit?, offset? })` | `products:read` |
 | `products.get(idOrSlug)` | `products:read` |
@@ -108,6 +109,8 @@ await skalp.products.submit(product.id)
 
 A product starts as a `DRAFT`. `submit` sends it to review, and the review sets `ACTIVE` or `REJECTED`; read the product to see which. `update` accepts only `DRAFT` and `ARCHIVED` as a `status`, and `archive` takes a product off sale without deleting anything. Pass `null` to `update` to clear `comparePrice`, `storeCategoryId`, `dynamicUrl` or `licenseDurationDays`.
 
+`price` is in your store currency, and buyers in Poland, the euro area, the US and Brazil pay it converted at the day's rate. To charge a round local price instead, pass `prices: [{ currency: 'PLN', price: 79 }]`: up to three currencies other than the store one, from 5 to 999999 each, not on coin packs. The list replaces the old one, and `[]` removes them.
+
 `addSerials` splits `text` on new lines unless you pass `delimiter` (`'comma'`, `'semicolon'` or any other string). A key the product already has is counted in `skipped` and not added again. `listSerials` returns the plain key values, which is why it needs `products:write`.
 
 ## Orders and customers
@@ -117,11 +120,19 @@ const { data: orders } = await skalp.orders.list({ status: 'COMPLETED', updatedS
 
 await skalp.orders.cancel(order.id)
 
+const { data: mine } = await skalp.orders.list({ identifier: ['steam:110000112345679', 'discord:123456789012345678'] })
+
+await skalp.orders.redeliver(order.id)
+
 const { replacements } = await skalp.orders.replace(order.id, { reason: 'Key does not activate' })
 ```
 
 `cancel` works only on a `PENDING` order and returns it as `CANCELED`. `replace` swaps the delivered keys of a completed order: with no `serialIds` it replaces every key, and with no `values` it draws the new ones from stock (`values` is required for keys that come from your server). The replacement keys come back in `replacements[].value`. `orders.get` also returns `serialsReplaced`, the `replacements` history and `serials`: the id, status, `deliveredAt` and `replacedById` of every delivered or replaced key (never its value), which are the ids `serialIds` expects.
 
+`identifier` keeps the orders of one player (up to 10 values of up to 200 characters; a longer list or value is a 400). A value is a game identity: `steam:<hex>`, a SteamID64, any `kind:value` such as `discord:123456789012345678` or `license:abc...`, or a bare value. It matches orders whose buyer or gift recipient signed in with that Steam account, or where a checkout custom field answer equals the value (case and a leading `kind:` prefix on either side are ignored). It combines with the other filters.
+
+`redeliver` takes the order's id or its number (`SKP-XXXX-XXXX-XXXX`) and sends a completed order that was not delivered again: a `FAILED` delivery goes back to `PENDING` and the `order.paid` and `purchase.completed` webhooks are sent again to the store's game server, which delivers it as a normal purchase. It returns the order as `orders.get` does. It answers 400 when the order is not `COMPLETED`, is already `DELIVERED`, is a gift nobody has claimed yet, or never had a licence issued, and 404 when the order is not in the key's store.
+
 `updatedSince` lists oldest change first, so you can page through it and keep the last `updatedAt` as your cursor; without it, newest orders come first. Amounts are in major units (`19.5`).
 
 Coupons take `validFrom`, `validTo` as an ISO string or a `Date`; `coupons.update` accepts `null` to clear `validTo`, `maxUses`, `minPurchaseAmount` and `description`.

package/dist/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import type { AccessRule, AddAccessRuleParams, AddSerialsParams, AddSerialsResult, AppealFeedbackParams, ChangeSubscriptionPlanParams, CheckoutSession, CheckoutSessionStatus, CoinCheckout, CoinCheckoutStatus, Coupon, CreateCheckoutParams, CreateCoinCheckoutParams, CreateCouponParams, CreateCustomerParams, CreateProductGroupParams, CreateProductParams, CreateStoreCategoryParams, CreateSubscriptionCheckoutParams, CreateUsageChargeParams, Customer, CustomerDetails, CustomerList, Deleted, Feedback, FeedbackList, HeartbeatParams, Invoice, LicenseKeyInfo, LicenseValidation, LicenseVerification, ListAccessRulesParams, ListCustomersParams, ListFeedbackParams, ListOrdersParams, ListProductsParams, ListQueriesParams, ListSerialsParams, ListSubscriptionsParams, Order, OrderKeysReplaced, OrderList, Product, ProductGroup, ProductStock, ReplaceOrderKeysParams, ReplyParams, SerialList, SkalpEvent, StoreCategory, StoreCategoryWithCount, Subscription, SubscriptionCheckout, SubscriptionCheckoutStatus, SubscriptionList, SupportQueryDetails, SupportQueryList, ResetLicenseDevicesParams, UpdateCouponParams, UpdateCustomerParams, UpdateProductGroupParams, UpdateProductParams, UpdateStoreCategoryParams, UsageCharge, ValidateLicenseParams, VerifyLicenseParams } from './types.js';
 export type * from './types.js';
-export declare const VERSION = "1.5.0";
+export declare const VERSION = "1.6.0";
 export interface SkalpOptions {
     apiKey?: string;
     webhookSecret?: string;
@@ -36,9 +36,10 @@ export declare class Skalp {
         get: (id: string) => Promise<CheckoutSessionStatus>;
     };
     readonly orders: {
-        list: ({ status, productId, email, createdAfter, createdBefore, updatedSince, limit, offset }?: ListOrdersParams) => Promise<OrderList>;
+        list: ({ status, productId, email, identifier, createdAfter, createdBefore, updatedSince, limit, offset }?: ListOrdersParams) => Promise<OrderList>;
         get: (id: string) => Promise<Order>;
         cancel: (id: string) => Promise<Order>;
+        redeliver: (id: string) => Promise<Order>;
         replace: (id: string, { serialIds, values, reason }?: ReplaceOrderKeysParams) => Promise<OrderKeysReplaced>;
     };
     readonly products: {

package/dist/cjs/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Skalp = exports.SkalpSignatureError = exports.SkalpConnectionError = exports.SkalpError = exports.VERSION = void 0;
-exports.VERSION = '1.5.0';
+exports.VERSION = '1.6.0';
 const SIGNATURE_HEADER = 'skalp-signature';
 const SIGNATURE_TOLERANCE_SECONDS = 300;
 const PRODUCT_PAGE = 100;
@@ -52,6 +52,7 @@ const PRODUCT_FIELDS = [
     'comparePrice',
     'category',
     'categoryId',
+    'game',
     'storeCategoryId',
     'tags',
     'images',
@@ -62,6 +63,24 @@ const PRODUCT_FIELDS = [
     'dynamicUrl',
     'licenseDeviceLimit',
     'licenseDurationDays',
+    'deliveryType',
+    'deliveryPayload',
+    'revokePayload',
+    'coinConfig',
+    'visibility',
+    'sortPriority',
+    'deliveryNote',
+    'termsOfService',
+    'warrantyDays',
+    'warrantyText',
+    'blockVpn',
+    'maxRiskScore',
+    'customFields',
+    'minQuantity',
+    'maxQuantity',
+    'volumeDiscounts',
+    'upsells',
+    'prices',
 ];
 const COUPON_FIELDS = [
     'discountType',
@@ -110,11 +129,12 @@ class Skalp {
         get: (id) => this.#request('GET', `/v1/checkout/sessions/${segment(id)}`),
     };
     orders = {
-        list: ({ status, productId, email, createdAfter, createdBefore, updatedSince, limit, offset } = {}) => this.#request('GET', '/v1/orders', {
+        list: ({ status, productId, email, identifier, createdAfter, createdBefore, updatedSince, limit, offset } = {}) => this.#request('GET', '/v1/orders', {
             query: {
                 status,
                 productId,
                 email,
+                identifier,
                 createdAfter: optionalDate(createdAfter),
                 createdBefore: optionalDate(createdBefore),
                 updatedSince: optionalDate(updatedSince),
@@ -124,6 +144,7 @@ class Skalp {
         }),
         get: (id) => this.#request('GET', `/v1/orders/${segment(id)}`),
         cancel: (id) => this.#request('POST', `/v1/orders/${segment(id)}/cancel`),
+        redeliver: (id) => this.#request('POST', `/v1/orders/${segment(id)}/redeliver`),
         replace: (id, { serialIds, values, reason } = {}) => this.#request('POST', `/v1/orders/${segment(id)}/replacement`, {
             body: { serialIds, values, reason },
         }),
@@ -318,7 +339,10 @@ class Skalp {
         }
         const url = new URL(this.#baseUrl + path);
         for (const [name, value] of Object.entries(query ?? {})) {
-            if (value !== undefined && value !== null)
+            if (Array.isArray(value))
+                for (const item of value)
+                    url.searchParams.append(name, String(item));
+            else if (value !== undefined && value !== null)
                 url.searchParams.set(name, String(value));
         }
         const headers = { accept: 'application/json', 'user-agent': USER_AGENT };

package/dist/cjs/types.d.ts

@@ -2,6 +2,7 @@ export type Currency = 'EUR' | 'USD' | 'PLN' | (string & {});
 export type FulfillmentType = 'FILE' | 'SERIAL' | 'GAME' | 'SERVICE' | 'DYNAMIC' | 'LICENSE';
 export type ProductStatus = 'DRAFT' | 'PENDING_REVIEW' | 'PROCESSING' | 'PROCESSING_FAILED' | 'ACTIVE' | 'REJECTED' | 'ARCHIVED';
 export type ProductType = 'ONE_TIME' | 'RECURRING' | 'COINS';
+export type Game = 'fivem' | 'minecraft' | 'rust';
 export type BillingInterval = 'WEEK' | 'MONTH' | 'YEAR';
 export type OrderStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'REFUNDED' | 'DISPUTED' | 'CANCELED';
 export type PaymentProvider = 'STRIPE' | 'NOWPAYMENTS' | 'PAYPAL';
@@ -91,6 +92,7 @@ export interface ListOrdersParams {
     status?: OrderStatus;
     productId?: string;
     email?: string;
+    identifier?: string | Array<string>;
     createdAfter?: string | Date;
     createdBefore?: string | Date;
     updatedSince?: string | Date;
@@ -176,6 +178,10 @@ export type DeliveryType = 'COMMAND' | 'SQL';
  * ON_HOLD is listed but not buyable, PRIVATE sells only through the API.
  */
 export type ProductVisibility = 'PUBLIC' | 'UNLISTED' | 'ON_HOLD' | 'PRIVATE';
+export interface ProductPrice {
+    currency: Currency;
+    price: number;
+}
 export interface Product {
     id: string;
     storeId: string;
@@ -186,12 +192,15 @@ export interface Product {
     price: number;
     comparePrice: number | null;
     currency: Currency;
+    /** Round prices the seller set in other currencies. A buyer whose local currency is listed pays it exactly. */
+    prices: Array<ProductPrice>;
     status: ProductStatus;
     rejectionReason: string | null;
     productType: ProductType;
     billingInterval: BillingInterval | null;
     trialPeriodDays: number;
     fulfillmentType: FulfillmentType | null;
+    game: Game | null;
     category: string;
     categoryId: string | null;
     storeCategoryId: string | null;
@@ -264,6 +273,7 @@ interface ProductFields {
     shortDescription?: string;
     category?: string;
     categoryId?: string;
+    game?: Game | null;
     storeCategoryId?: string | null;
     tags?: Array<string>;
     images?: Array<string>;
@@ -299,6 +309,8 @@ interface ProductFields {
     volumeDiscounts?: Array<VolumeDiscount> | null;
     /** Up to 3 one-time products of the store; the list replaces the old one, [] or null removes them all. */
     upsells?: Array<ProductUpsellInput> | null;
+    /** Up to 3 currencies other than the store currency, not for coin packs; the list replaces the old one, [] or null removes them all. */
+    prices?: Array<ProductPrice> | null;
 }
 export interface CreateProductParams extends ProductFields {
     name: string;
@@ -886,6 +898,7 @@ export interface ProductEventData {
     price: number;
     fulfillmentType: FulfillmentType | null;
     productType: ProductType;
+    game: Game | null;
 }
 export interface ProductStockData {
     productId: string;

package/dist/esm/index.d.ts

@@ -1,6 +1,6 @@
 import type { AccessRule, AddAccessRuleParams, AddSerialsParams, AddSerialsResult, AppealFeedbackParams, ChangeSubscriptionPlanParams, CheckoutSession, CheckoutSessionStatus, CoinCheckout, CoinCheckoutStatus, Coupon, CreateCheckoutParams, CreateCoinCheckoutParams, CreateCouponParams, CreateCustomerParams, CreateProductGroupParams, CreateProductParams, CreateStoreCategoryParams, CreateSubscriptionCheckoutParams, CreateUsageChargeParams, Customer, CustomerDetails, CustomerList, Deleted, Feedback, FeedbackList, HeartbeatParams, Invoice, LicenseKeyInfo, LicenseValidation, LicenseVerification, ListAccessRulesParams, ListCustomersParams, ListFeedbackParams, ListOrdersParams, ListProductsParams, ListQueriesParams, ListSerialsParams, ListSubscriptionsParams, Order, OrderKeysReplaced, OrderList, Product, ProductGroup, ProductStock, ReplaceOrderKeysParams, ReplyParams, SerialList, SkalpEvent, StoreCategory, StoreCategoryWithCount, Subscription, SubscriptionCheckout, SubscriptionCheckoutStatus, SubscriptionList, SupportQueryDetails, SupportQueryList, ResetLicenseDevicesParams, UpdateCouponParams, UpdateCustomerParams, UpdateProductGroupParams, UpdateProductParams, UpdateStoreCategoryParams, UsageCharge, ValidateLicenseParams, VerifyLicenseParams } from './types.js';
 export type * from './types.js';
-export declare const VERSION = "1.5.0";
+export declare const VERSION = "1.6.0";
 export interface SkalpOptions {
     apiKey?: string;
     webhookSecret?: string;
@@ -36,9 +36,10 @@ export declare class Skalp {
         get: (id: string) => Promise<CheckoutSessionStatus>;
     };
     readonly orders: {
-        list: ({ status, productId, email, createdAfter, createdBefore, updatedSince, limit, offset }?: ListOrdersParams) => Promise<OrderList>;
+        list: ({ status, productId, email, identifier, createdAfter, createdBefore, updatedSince, limit, offset }?: ListOrdersParams) => Promise<OrderList>;
         get: (id: string) => Promise<Order>;
         cancel: (id: string) => Promise<Order>;
+        redeliver: (id: string) => Promise<Order>;
         replace: (id: string, { serialIds, values, reason }?: ReplaceOrderKeysParams) => Promise<OrderKeysReplaced>;
     };
     readonly products: {

package/dist/esm/index.js

@@ -1,4 +1,4 @@
-export const VERSION = '1.5.0';
+export const VERSION = '1.6.0';
 const SIGNATURE_HEADER = 'skalp-signature';
 const SIGNATURE_TOLERANCE_SECONDS = 300;
 const PRODUCT_PAGE = 100;
@@ -46,6 +46,7 @@ const PRODUCT_FIELDS = [
     'comparePrice',
     'category',
     'categoryId',
+    'game',
     'storeCategoryId',
     'tags',
     'images',
@@ -56,6 +57,24 @@ const PRODUCT_FIELDS = [
     'dynamicUrl',
     'licenseDeviceLimit',
     'licenseDurationDays',
+    'deliveryType',
+    'deliveryPayload',
+    'revokePayload',
+    'coinConfig',
+    'visibility',
+    'sortPriority',
+    'deliveryNote',
+    'termsOfService',
+    'warrantyDays',
+    'warrantyText',
+    'blockVpn',
+    'maxRiskScore',
+    'customFields',
+    'minQuantity',
+    'maxQuantity',
+    'volumeDiscounts',
+    'upsells',
+    'prices',
 ];
 const COUPON_FIELDS = [
     'discountType',
@@ -104,11 +123,12 @@ export class Skalp {
         get: (id) => this.#request('GET', `/v1/checkout/sessions/${segment(id)}`),
     };
     orders = {
-        list: ({ status, productId, email, createdAfter, createdBefore, updatedSince, limit, offset } = {}) => this.#request('GET', '/v1/orders', {
+        list: ({ status, productId, email, identifier, createdAfter, createdBefore, updatedSince, limit, offset } = {}) => this.#request('GET', '/v1/orders', {
             query: {
                 status,
                 productId,
                 email,
+                identifier,
                 createdAfter: optionalDate(createdAfter),
                 createdBefore: optionalDate(createdBefore),
                 updatedSince: optionalDate(updatedSince),
@@ -118,6 +138,7 @@ export class Skalp {
         }),
         get: (id) => this.#request('GET', `/v1/orders/${segment(id)}`),
         cancel: (id) => this.#request('POST', `/v1/orders/${segment(id)}/cancel`),
+        redeliver: (id) => this.#request('POST', `/v1/orders/${segment(id)}/redeliver`),
         replace: (id, { serialIds, values, reason } = {}) => this.#request('POST', `/v1/orders/${segment(id)}/replacement`, {
             body: { serialIds, values, reason },
         }),
@@ -312,7 +333,10 @@ export class Skalp {
         }
         const url = new URL(this.#baseUrl + path);
         for (const [name, value] of Object.entries(query ?? {})) {
-            if (value !== undefined && value !== null)
+            if (Array.isArray(value))
+                for (const item of value)
+                    url.searchParams.append(name, String(item));
+            else if (value !== undefined && value !== null)
                 url.searchParams.set(name, String(value));
         }
         const headers = { accept: 'application/json', 'user-agent': USER_AGENT };

package/dist/esm/types.d.ts

@@ -2,6 +2,7 @@ export type Currency = 'EUR' | 'USD' | 'PLN' | (string & {});
 export type FulfillmentType = 'FILE' | 'SERIAL' | 'GAME' | 'SERVICE' | 'DYNAMIC' | 'LICENSE';
 export type ProductStatus = 'DRAFT' | 'PENDING_REVIEW' | 'PROCESSING' | 'PROCESSING_FAILED' | 'ACTIVE' | 'REJECTED' | 'ARCHIVED';
 export type ProductType = 'ONE_TIME' | 'RECURRING' | 'COINS';
+export type Game = 'fivem' | 'minecraft' | 'rust';
 export type BillingInterval = 'WEEK' | 'MONTH' | 'YEAR';
 export type OrderStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'REFUNDED' | 'DISPUTED' | 'CANCELED';
 export type PaymentProvider = 'STRIPE' | 'NOWPAYMENTS' | 'PAYPAL';
@@ -91,6 +92,7 @@ export interface ListOrdersParams {
     status?: OrderStatus;
     productId?: string;
     email?: string;
+    identifier?: string | Array<string>;
     createdAfter?: string | Date;
     createdBefore?: string | Date;
     updatedSince?: string | Date;
@@ -176,6 +178,10 @@ export type DeliveryType = 'COMMAND' | 'SQL';
  * ON_HOLD is listed but not buyable, PRIVATE sells only through the API.
  */
 export type ProductVisibility = 'PUBLIC' | 'UNLISTED' | 'ON_HOLD' | 'PRIVATE';
+export interface ProductPrice {
+    currency: Currency;
+    price: number;
+}
 export interface Product {
     id: string;
     storeId: string;
@@ -186,12 +192,15 @@ export interface Product {
     price: number;
     comparePrice: number | null;
     currency: Currency;
+    /** Round prices the seller set in other currencies. A buyer whose local currency is listed pays it exactly. */
+    prices: Array<ProductPrice>;
     status: ProductStatus;
     rejectionReason: string | null;
     productType: ProductType;
     billingInterval: BillingInterval | null;
     trialPeriodDays: number;
     fulfillmentType: FulfillmentType | null;
+    game: Game | null;
     category: string;
     categoryId: string | null;
     storeCategoryId: string | null;
@@ -264,6 +273,7 @@ interface ProductFields {
     shortDescription?: string;
     category?: string;
     categoryId?: string;
+    game?: Game | null;
     storeCategoryId?: string | null;
     tags?: Array<string>;
     images?: Array<string>;
@@ -299,6 +309,8 @@ interface ProductFields {
     volumeDiscounts?: Array<VolumeDiscount> | null;
     /** Up to 3 one-time products of the store; the list replaces the old one, [] or null removes them all. */
     upsells?: Array<ProductUpsellInput> | null;
+    /** Up to 3 currencies other than the store currency, not for coin packs; the list replaces the old one, [] or null removes them all. */
+    prices?: Array<ProductPrice> | null;
 }
 export interface CreateProductParams extends ProductFields {
     name: string;
@@ -886,6 +898,7 @@ export interface ProductEventData {
     price: number;
     fulfillmentType: FulfillmentType | null;
     productType: ProductType;
+    game: Game | null;
 }
 export interface ProductStockData {
     productId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skalpgg/sdk",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Official Skalp SDK for Node.js and edge runtimes: checkout, subscriptions, catalog and key stock, webhooks and license verification.",
   "license": "MIT",
   "homepage": "https://skalp.gg/docs/sdk",