@rechargeapps/storefront-client 1.3.1 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cjs/api/address.js
CHANGED
|
@@ -4,6 +4,22 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
4
4
|
|
|
5
5
|
var request = require('../utils/request.js');
|
|
6
6
|
|
|
7
|
+
var __defProp = Object.defineProperty;
|
|
8
|
+
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
|
|
9
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
10
|
+
var __propIsEnum = Object.prototype.propertyIsEnumerable;
|
|
11
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
12
|
+
var __spreadValues = (a, b) => {
|
|
13
|
+
for (var prop in b || (b = {}))
|
|
14
|
+
if (__hasOwnProp.call(b, prop))
|
|
15
|
+
__defNormalProp(a, prop, b[prop]);
|
|
16
|
+
if (__getOwnPropSymbols)
|
|
17
|
+
for (var prop of __getOwnPropSymbols(b)) {
|
|
18
|
+
if (__propIsEnum.call(b, prop))
|
|
19
|
+
__defNormalProp(a, prop, b[prop]);
|
|
20
|
+
}
|
|
21
|
+
return a;
|
|
22
|
+
};
|
|
7
23
|
function listAddresses(session, query) {
|
|
8
24
|
return request.rechargeApiRequest("get", `/addresses`, { query }, session);
|
|
9
25
|
}
|
|
@@ -12,7 +28,7 @@ async function getAddress(session, id, options) {
|
|
|
12
28
|
return address;
|
|
13
29
|
}
|
|
14
30
|
async function createAddress(session, createRequest) {
|
|
15
|
-
const { address } = await request.rechargeApiRequest("post", `/addresses`, { data: createRequest }, session);
|
|
31
|
+
const { address } = await request.rechargeApiRequest("post", `/addresses`, { data: __spreadValues({ customer_id: session.customerId ? Number(session.customerId) : void 0 }, createRequest) }, session);
|
|
16
32
|
return address;
|
|
17
33
|
}
|
|
18
34
|
async function updateAddress(session, id, updateRequest) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"address.js","sources":["../../../src/api/address.ts"],"sourcesContent":["import { rechargeApiRequest } from '../utils/request';\nimport {\n AddressResponse,\n AddressListParams,\n CreateAddressRequest,\n UpdateAddressRequest,\n AddressListResponse,\n MergeAddressesRequest,\n SkipFutureChargeAddressRequest,\n SkipFutureChargeAddressResponse,\n GetAddressOptions,\n} from '../types/address';\nimport { Session } from '../types/session';\n\n/** Returns all addresses from the store, or addresses for the customer given in the parameter. */\nexport function listAddresses(session: Session, query?: AddressListParams) {\n return rechargeApiRequest<AddressListResponse>('get', `/addresses`, { query }, session);\n}\n\n/** Retrieves address for customer based on specified address id. */\nexport async function getAddress(session: Session, id: string | number, options?: GetAddressOptions) {\n const { address } = await rechargeApiRequest<AddressResponse>(\n 'get',\n `/addresses`,\n { id, query: { include: options?.include } },\n session\n );\n return address;\n}\n\n/** Create a new address for a customer. */\nexport async function createAddress(session: Session, createRequest: CreateAddressRequest) {\n const { address } = await rechargeApiRequest<AddressResponse>('post'
|
|
1
|
+
{"version":3,"file":"address.js","sources":["../../../src/api/address.ts"],"sourcesContent":["import { rechargeApiRequest } from '../utils/request';\nimport {\n AddressResponse,\n AddressListParams,\n CreateAddressRequest,\n UpdateAddressRequest,\n AddressListResponse,\n MergeAddressesRequest,\n SkipFutureChargeAddressRequest,\n SkipFutureChargeAddressResponse,\n GetAddressOptions,\n} from '../types/address';\nimport { Session } from '../types/session';\n\n/** Returns all addresses from the store, or addresses for the customer given in the parameter. */\nexport function listAddresses(session: Session, query?: AddressListParams) {\n return rechargeApiRequest<AddressListResponse>('get', `/addresses`, { query }, session);\n}\n\n/** Retrieves address for customer based on specified address id. */\nexport async function getAddress(session: Session, id: string | number, options?: GetAddressOptions) {\n const { address } = await rechargeApiRequest<AddressResponse>(\n 'get',\n `/addresses`,\n { id, query: { include: options?.include } },\n session\n );\n return address;\n}\n\n/** Create a new address for a customer. */\nexport async function createAddress(session: Session, createRequest: CreateAddressRequest) {\n const { address } = await rechargeApiRequest<AddressResponse>(\n 'post',\n `/addresses`,\n { data: { customer_id: session.customerId ? Number(session.customerId) : undefined, ...createRequest } },\n session\n );\n return address;\n}\n\n/** Updates an existing address to match the specified parameters. */\nexport async function updateAddress(session: Session, id: string | number, updateRequest: UpdateAddressRequest) {\n const { address } = await rechargeApiRequest<AddressResponse>(\n 'put',\n `/addresses`,\n { id, data: updateRequest },\n session\n );\n return address;\n}\n\n/** Apply discount code to an address. Addresses are currently limited to a single discount. */\nexport async function applyDiscountToAddress(session: Session, id: string | number, discountCode: string) {\n return updateAddress(session, id, { discounts: [{ code: discountCode }] });\n}\n\n/** Removes all discounts from an address. */\nexport async function removeDiscountsFromAddress(session: Session, id: string | number) {\n return updateAddress(session, id, { discounts: [] });\n}\n\n/** Deletes an address. Only Addresses with no active Subscriptions can be deleted. */\nexport function deleteAddress(session: Session, id: string | number) {\n return rechargeApiRequest<void>('delete', `/addresses`, { id }, session);\n}\n\n/**\n * Merges up to 10 source addresses into 1 target address.\n */\nexport async function mergeAddresses(session: Session, mergeRequest: MergeAddressesRequest) {\n const { address } = await rechargeApiRequest<AddressResponse>(\n 'post',\n `/addresses/merge`,\n {\n data: mergeRequest,\n },\n session\n );\n return address;\n}\n\n/**\n * Skip a Charge in the future for one or multiple Subscriptions associated with the Address.\n */\nexport async function skipFutureCharge(\n session: Session,\n id: string | number,\n skipRequest: SkipFutureChargeAddressRequest\n) {\n const { charge } = await rechargeApiRequest<SkipFutureChargeAddressResponse>(\n 'post',\n `/addresses/${id}/charges/skip`,\n {\n data: skipRequest,\n },\n session\n );\n return charge;\n}\n"],"names":["rechargeApiRequest"],"mappings":";;;;;;AAAA,IAAI,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC;AACtC,IAAI,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACvD,IAAI,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC;AACnD,IAAI,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,oBAAoB,CAAC;AACzD,IAAI,eAAe,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,KAAK,GAAG,IAAI,GAAG,GAAG,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAChK,IAAI,cAAc,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK;AAC/B,EAAE,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;AAChC,IAAI,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC;AAClC,MAAM,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AACxC,EAAE,IAAI,mBAAmB;AACzB,IAAI,KAAK,IAAI,IAAI,IAAI,mBAAmB,CAAC,CAAC,CAAC,EAAE;AAC7C,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC;AACpC,QAAQ,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAC1C,KAAK;AACL,EAAE,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEK,SAAS,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE;AAC9C,EAAE,OAAOA,0BAAkB,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;AACrE,CAAC;AACM,eAAe,UAAU,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE;AACvD,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAMA,0BAAkB,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;AACrJ,EAAE,OAAO,OAAO,CAAC;AACjB,CAAC;AACM,eAAe,aAAa,CAAC,OAAO,EAAE,aAAa,EAAE;AAC5D,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAMA,0BAAkB,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;AAClM,EAAE,OAAO,OAAO,CAAC;AACjB,CAAC;AACM,eAAe,aAAa,CAAC,OAAO,EAAE,EAAE,EAAE,aAAa,EAAE;AAChE,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAMA,0BAAkB,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;AAC1G,EAAE,OAAO,OAAO,CAAC;AACjB,CAAC;AACM,eAAe,sBAAsB,CAAC,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE;AACxE,EAAE,OAAO,aAAa,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC;AAC7E,CAAC;AACM,eAAe,0BAA0B,CAAC,OAAO,EAAE,EAAE,EAAE;AAC9D,EAAE,OAAO,aAAa,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;AACvD,CAAC;AACM,SAAS,aAAa,CAAC,OAAO,EAAE,EAAE,EAAE;AAC3C,EAAE,OAAOA,0BAAkB,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;AACrE,CAAC;AACM,eAAe,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE;AAC5D,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAMA,0BAAkB,CAAC,MAAM,EAAE,CAAC,gBAAgB,CAAC,EAAE;AAC3E,IAAI,IAAI,EAAE,YAAY;AACtB,GAAG,EAAE,OAAO,CAAC,CAAC;AACd,EAAE,OAAO,OAAO,CAAC;AACjB,CAAC;AACM,eAAe,gBAAgB,CAAC,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE;AACjE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAMA,0BAAkB,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,aAAa,CAAC,EAAE;AACvF,IAAI,IAAI,EAAE,WAAW;AACrB,GAAG,EAAE,OAAO,CAAC,CAAC;AACd,EAAE,OAAO,MAAM,CAAC;AAChB;;;;;;;;;;;;"}
|
package/dist/esm/api/address.js
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
import { rechargeApiRequest } from '../utils/request.js';
|
|
2
2
|
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __propIsEnum = Object.prototype.propertyIsEnumerable;
|
|
7
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
8
|
+
var __spreadValues = (a, b) => {
|
|
9
|
+
for (var prop in b || (b = {}))
|
|
10
|
+
if (__hasOwnProp.call(b, prop))
|
|
11
|
+
__defNormalProp(a, prop, b[prop]);
|
|
12
|
+
if (__getOwnPropSymbols)
|
|
13
|
+
for (var prop of __getOwnPropSymbols(b)) {
|
|
14
|
+
if (__propIsEnum.call(b, prop))
|
|
15
|
+
__defNormalProp(a, prop, b[prop]);
|
|
16
|
+
}
|
|
17
|
+
return a;
|
|
18
|
+
};
|
|
3
19
|
function listAddresses(session, query) {
|
|
4
20
|
return rechargeApiRequest("get", `/addresses`, { query }, session);
|
|
5
21
|
}
|
|
@@ -8,7 +24,7 @@ async function getAddress(session, id, options) {
|
|
|
8
24
|
return address;
|
|
9
25
|
}
|
|
10
26
|
async function createAddress(session, createRequest) {
|
|
11
|
-
const { address } = await rechargeApiRequest("post", `/addresses`, { data: createRequest }, session);
|
|
27
|
+
const { address } = await rechargeApiRequest("post", `/addresses`, { data: __spreadValues({ customer_id: session.customerId ? Number(session.customerId) : void 0 }, createRequest) }, session);
|
|
12
28
|
return address;
|
|
13
29
|
}
|
|
14
30
|
async function updateAddress(session, id, updateRequest) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"address.js","sources":["../../../src/api/address.ts"],"sourcesContent":["import { rechargeApiRequest } from '../utils/request';\nimport {\n AddressResponse,\n AddressListParams,\n CreateAddressRequest,\n UpdateAddressRequest,\n AddressListResponse,\n MergeAddressesRequest,\n SkipFutureChargeAddressRequest,\n SkipFutureChargeAddressResponse,\n GetAddressOptions,\n} from '../types/address';\nimport { Session } from '../types/session';\n\n/** Returns all addresses from the store, or addresses for the customer given in the parameter. */\nexport function listAddresses(session: Session, query?: AddressListParams) {\n return rechargeApiRequest<AddressListResponse>('get', `/addresses`, { query }, session);\n}\n\n/** Retrieves address for customer based on specified address id. */\nexport async function getAddress(session: Session, id: string | number, options?: GetAddressOptions) {\n const { address } = await rechargeApiRequest<AddressResponse>(\n 'get',\n `/addresses`,\n { id, query: { include: options?.include } },\n session\n );\n return address;\n}\n\n/** Create a new address for a customer. */\nexport async function createAddress(session: Session, createRequest: CreateAddressRequest) {\n const { address } = await rechargeApiRequest<AddressResponse>('post'
|
|
1
|
+
{"version":3,"file":"address.js","sources":["../../../src/api/address.ts"],"sourcesContent":["import { rechargeApiRequest } from '../utils/request';\nimport {\n AddressResponse,\n AddressListParams,\n CreateAddressRequest,\n UpdateAddressRequest,\n AddressListResponse,\n MergeAddressesRequest,\n SkipFutureChargeAddressRequest,\n SkipFutureChargeAddressResponse,\n GetAddressOptions,\n} from '../types/address';\nimport { Session } from '../types/session';\n\n/** Returns all addresses from the store, or addresses for the customer given in the parameter. */\nexport function listAddresses(session: Session, query?: AddressListParams) {\n return rechargeApiRequest<AddressListResponse>('get', `/addresses`, { query }, session);\n}\n\n/** Retrieves address for customer based on specified address id. */\nexport async function getAddress(session: Session, id: string | number, options?: GetAddressOptions) {\n const { address } = await rechargeApiRequest<AddressResponse>(\n 'get',\n `/addresses`,\n { id, query: { include: options?.include } },\n session\n );\n return address;\n}\n\n/** Create a new address for a customer. */\nexport async function createAddress(session: Session, createRequest: CreateAddressRequest) {\n const { address } = await rechargeApiRequest<AddressResponse>(\n 'post',\n `/addresses`,\n { data: { customer_id: session.customerId ? Number(session.customerId) : undefined, ...createRequest } },\n session\n );\n return address;\n}\n\n/** Updates an existing address to match the specified parameters. */\nexport async function updateAddress(session: Session, id: string | number, updateRequest: UpdateAddressRequest) {\n const { address } = await rechargeApiRequest<AddressResponse>(\n 'put',\n `/addresses`,\n { id, data: updateRequest },\n session\n );\n return address;\n}\n\n/** Apply discount code to an address. Addresses are currently limited to a single discount. */\nexport async function applyDiscountToAddress(session: Session, id: string | number, discountCode: string) {\n return updateAddress(session, id, { discounts: [{ code: discountCode }] });\n}\n\n/** Removes all discounts from an address. */\nexport async function removeDiscountsFromAddress(session: Session, id: string | number) {\n return updateAddress(session, id, { discounts: [] });\n}\n\n/** Deletes an address. Only Addresses with no active Subscriptions can be deleted. */\nexport function deleteAddress(session: Session, id: string | number) {\n return rechargeApiRequest<void>('delete', `/addresses`, { id }, session);\n}\n\n/**\n * Merges up to 10 source addresses into 1 target address.\n */\nexport async function mergeAddresses(session: Session, mergeRequest: MergeAddressesRequest) {\n const { address } = await rechargeApiRequest<AddressResponse>(\n 'post',\n `/addresses/merge`,\n {\n data: mergeRequest,\n },\n session\n );\n return address;\n}\n\n/**\n * Skip a Charge in the future for one or multiple Subscriptions associated with the Address.\n */\nexport async function skipFutureCharge(\n session: Session,\n id: string | number,\n skipRequest: SkipFutureChargeAddressRequest\n) {\n const { charge } = await rechargeApiRequest<SkipFutureChargeAddressResponse>(\n 'post',\n `/addresses/${id}/charges/skip`,\n {\n data: skipRequest,\n },\n session\n );\n return charge;\n}\n"],"names":[],"mappings":";;AAAA,IAAI,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC;AACtC,IAAI,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACvD,IAAI,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC;AACnD,IAAI,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,oBAAoB,CAAC;AACzD,IAAI,eAAe,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,KAAK,GAAG,IAAI,GAAG,GAAG,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAChK,IAAI,cAAc,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK;AAC/B,EAAE,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;AAChC,IAAI,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC;AAClC,MAAM,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AACxC,EAAE,IAAI,mBAAmB;AACzB,IAAI,KAAK,IAAI,IAAI,IAAI,mBAAmB,CAAC,CAAC,CAAC,EAAE;AAC7C,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC;AACpC,QAAQ,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAC1C,KAAK;AACL,EAAE,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEK,SAAS,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE;AAC9C,EAAE,OAAO,kBAAkB,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;AACrE,CAAC;AACM,eAAe,UAAU,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE;AACvD,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,kBAAkB,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;AACrJ,EAAE,OAAO,OAAO,CAAC;AACjB,CAAC;AACM,eAAe,aAAa,CAAC,OAAO,EAAE,aAAa,EAAE;AAC5D,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;AAClM,EAAE,OAAO,OAAO,CAAC;AACjB,CAAC;AACM,eAAe,aAAa,CAAC,OAAO,EAAE,EAAE,EAAE,aAAa,EAAE;AAChE,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,kBAAkB,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;AAC1G,EAAE,OAAO,OAAO,CAAC;AACjB,CAAC;AACM,eAAe,sBAAsB,CAAC,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE;AACxE,EAAE,OAAO,aAAa,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC;AAC7E,CAAC;AACM,eAAe,0BAA0B,CAAC,OAAO,EAAE,EAAE,EAAE;AAC9D,EAAE,OAAO,aAAa,CAAC,OAAO,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;AACvD,CAAC;AACM,SAAS,aAAa,CAAC,OAAO,EAAE,EAAE,EAAE;AAC3C,EAAE,OAAO,kBAAkB,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;AACrE,CAAC;AACM,eAAe,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE;AAC5D,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,CAAC,gBAAgB,CAAC,EAAE;AAC3E,IAAI,IAAI,EAAE,YAAY;AACtB,GAAG,EAAE,OAAO,CAAC,CAAC;AACd,EAAE,OAAO,OAAO,CAAC;AACjB,CAAC;AACM,eAAe,gBAAgB,CAAC,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE;AACjE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,aAAa,CAAC,EAAE;AACvF,IAAI,IAAI,EAAE,WAAW;AACrB,GAAG,EAAE,OAAO,CAAC,CAAC;AACd,EAAE,OAAO,MAAM,CAAC;AAChB;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ interface ListParams<T> {
|
|
|
12
12
|
/** default is 50, max is 250 */
|
|
13
13
|
limit?: number;
|
|
14
14
|
/** next or previous cursor returned by previous list call */
|
|
15
|
-
cursor?:
|
|
15
|
+
cursor?: string;
|
|
16
16
|
/** sort list by option */
|
|
17
17
|
sort_by?: T;
|
|
18
18
|
}
|
|
@@ -237,7 +237,7 @@ interface PaymentMethodListParams extends ListParams<PaymentMethodSortBy> {
|
|
|
237
237
|
/** Return the payment_methods linked to the given processor_name. */
|
|
238
238
|
processor_name?: ProcessorName;
|
|
239
239
|
/** Return the payment_methods linked to the given address_id. */
|
|
240
|
-
address_id?: string;
|
|
240
|
+
address_id?: string | number;
|
|
241
241
|
/** Return the payment_methods linked to the given processor_payment_method_token. */
|
|
242
242
|
processor_payment_method_token?: string;
|
|
243
243
|
/** Include related data options */
|
|
@@ -345,9 +345,9 @@ interface GetSubscriptionOptions {
|
|
|
345
345
|
type SubscriptionSortBy = 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-asc' | 'updated_at-desc';
|
|
346
346
|
interface SubscriptionListParams extends ListParams<SubscriptionSortBy> {
|
|
347
347
|
/** Return the subscriptions linked to the given address_id. */
|
|
348
|
-
address_id?: string;
|
|
348
|
+
address_id?: string | number;
|
|
349
349
|
/** Return the subscriptions linked to the given address_ids. */
|
|
350
|
-
address_ids?: string[];
|
|
350
|
+
address_ids?: (string | number)[];
|
|
351
351
|
/** Return the subscriptions created before the given date. */
|
|
352
352
|
created_at_max?: IsoDateString;
|
|
353
353
|
/** Return the subscriptions created after the given date. */
|
|
@@ -355,7 +355,7 @@ interface SubscriptionListParams extends ListParams<SubscriptionSortBy> {
|
|
|
355
355
|
/** Return the subscriptions linked to the given external_variant_id */
|
|
356
356
|
external_variant_id?: string;
|
|
357
357
|
/** Comma-separated list of subscription_ids to filter */
|
|
358
|
-
ids?: string[];
|
|
358
|
+
ids?: (string | number)[];
|
|
359
359
|
/** Return the subscriptions with specified status. */
|
|
360
360
|
status?: SubscriptionStatus;
|
|
361
361
|
/** Return the subscriptions updated before the given date. */
|
|
@@ -658,29 +658,29 @@ interface OrdersResponse {
|
|
|
658
658
|
type OrderSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'processed_at-asc' | 'processed_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
|
|
659
659
|
interface OrderListParams extends ListParams<OrderSortBy> {
|
|
660
660
|
/** Filter orders by address. */
|
|
661
|
-
address_id?: string;
|
|
661
|
+
address_id?: string | number;
|
|
662
662
|
/** Filter orders by charge. */
|
|
663
|
-
charge_id?: string;
|
|
663
|
+
charge_id?: string | number;
|
|
664
664
|
/** Show orders created after the given date. */
|
|
665
665
|
created_at_min?: IsoDateString;
|
|
666
666
|
/** Show orders created before the given date. */
|
|
667
667
|
created_at_max?: IsoDateString;
|
|
668
668
|
/** Filter orders by external_order_id. */
|
|
669
|
-
external_order_id?: string;
|
|
669
|
+
external_order_id?: string | number;
|
|
670
670
|
/** Filter orders by id. */
|
|
671
|
-
ids?: string[];
|
|
671
|
+
ids?: (string | number)[];
|
|
672
672
|
/** Show orders scheduled before the given date. */
|
|
673
673
|
scheduled_at_max?: IsoDateString;
|
|
674
674
|
/** Show orders scheduled after the given date. */
|
|
675
675
|
scheduled_at_min?: IsoDateString;
|
|
676
676
|
/** Filter orders with/without external_order_id. */
|
|
677
|
-
has_external_order?:
|
|
677
|
+
has_external_order?: boolean;
|
|
678
678
|
/** Filter orders by status. */
|
|
679
679
|
status?: OrderStatus;
|
|
680
680
|
/** Filter orders by type. */
|
|
681
681
|
type?: OrderType;
|
|
682
682
|
/** Filter orders by subscription or onetime. */
|
|
683
|
-
purchase_item_id?: string;
|
|
683
|
+
purchase_item_id?: string | number;
|
|
684
684
|
/** Show orders updated before the given date. */
|
|
685
685
|
updated_at_max?: IsoDateString;
|
|
686
686
|
/** Show orders updated after the given date. */
|
|
@@ -727,6 +727,8 @@ interface Charge {
|
|
|
727
727
|
external_order_id: ExternalId;
|
|
728
728
|
/** An object containing the associated external transaction ID. */
|
|
729
729
|
external_transaction_id: ExternalTransactionId;
|
|
730
|
+
/** Specifies whether the Charge is scheduled for a regeneration (if the Subscription related to the charge was updated in the last 5 seconds using commit=false). */
|
|
731
|
+
has_uncommited_changes?: boolean;
|
|
730
732
|
/** A list of line_item objects, each containing information about a distinct purchase item. */
|
|
731
733
|
line_items: LineItem[];
|
|
732
734
|
/** Notes associated with the Charge. */
|
|
@@ -739,8 +741,6 @@ interface Charge {
|
|
|
739
741
|
payment_processor: string;
|
|
740
742
|
/** The date and time when the transaction was processed. */
|
|
741
743
|
processed_at: IsoDateString;
|
|
742
|
-
/** The date when the next attempt will be placed. */
|
|
743
|
-
retry_date: IsoDateString;
|
|
744
744
|
/** The date time of when the Charge is/was scheduled to process. */
|
|
745
745
|
scheduled_at: IsoDateString;
|
|
746
746
|
/** The shipping Address of the Charge. */
|
|
@@ -779,6 +779,16 @@ interface Charge {
|
|
|
779
779
|
metafields?: Metafield[];
|
|
780
780
|
payment_methods?: PaymentMethod[];
|
|
781
781
|
};
|
|
782
|
+
/** Error reason as sentence text (typically returned direct from the payment processor). e.g. "error": "Customer needs to update credit card" */
|
|
783
|
+
error?: string;
|
|
784
|
+
/** Structured reason why the charge failed such as CUSTOMER_NEEDS_TO_UPDATE_CARD. */
|
|
785
|
+
error_type?: string;
|
|
786
|
+
/** Shows how many times an attempt to charge was placed. */
|
|
787
|
+
charge_attempts?: number;
|
|
788
|
+
/** Indicates if Recharge was able to find the external_variant_id from the Charge. */
|
|
789
|
+
external_variant_id_not_found?: boolean;
|
|
790
|
+
/** The date when the next attempt will be placed. */
|
|
791
|
+
retry_date?: IsoDateString;
|
|
782
792
|
}
|
|
783
793
|
interface ChargeResponse {
|
|
784
794
|
charge: Charge;
|
|
@@ -795,22 +805,22 @@ interface GetChargeOptions {
|
|
|
795
805
|
type ChargeSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
|
|
796
806
|
interface ChargeListParams extends ListParams<ChargeSortBy> {
|
|
797
807
|
/** Filter Charges by Address. */
|
|
798
|
-
address_id?: string;
|
|
808
|
+
address_id?: string | number;
|
|
799
809
|
/** List Charges that contain the given discount_id. */
|
|
800
|
-
discount_id?: string;
|
|
810
|
+
discount_id?: string | number;
|
|
801
811
|
/** List Charges that contain the given discount_code. */
|
|
802
812
|
discount_code?: string;
|
|
803
813
|
/** Filter Charges by the associated order ID in the external e-commerce platform. */
|
|
804
|
-
external_order_id?: string;
|
|
814
|
+
external_order_id?: string | number;
|
|
805
815
|
/**
|
|
806
816
|
* Filter Charges by ID.
|
|
807
817
|
* If passing multiple values, must be comma separated. Non-integer values will result in a 422 error.
|
|
808
818
|
*/
|
|
809
|
-
ids?: string;
|
|
819
|
+
ids?: string | number;
|
|
810
820
|
/** Filter Charges by a Subscription or Onetime ID. */
|
|
811
|
-
purchase_item_id?: string;
|
|
821
|
+
purchase_item_id?: string | number;
|
|
812
822
|
/** Filter Charges by a comma-separated list of Subscription or Onetime IDs. */
|
|
813
|
-
purchase_item_ids?: string;
|
|
823
|
+
purchase_item_ids?: string | number;
|
|
814
824
|
/** Filter Charges by specific scheduled charge date. */
|
|
815
825
|
scheduled_at?: IsoDateString;
|
|
816
826
|
/** Show Charges scheduled to be processed before the given date. */
|
|
@@ -836,8 +846,8 @@ interface ChargeListParams extends ListParams<ChargeSortBy> {
|
|
|
836
846
|
}
|
|
837
847
|
|
|
838
848
|
interface CreateAddressRequest {
|
|
839
|
-
/** Unique numeric identifier for the customer associated with the address
|
|
840
|
-
customer_id
|
|
849
|
+
/** Unique numeric identifier for the customer associated with the address, if not provided will be auto-filled from Session */
|
|
850
|
+
customer_id?: number;
|
|
841
851
|
/** The street associated with the Address. Minimum length is 1 character. */
|
|
842
852
|
address1: string;
|
|
843
853
|
/** Any additional information associated with the Address. */
|
|
@@ -977,7 +987,7 @@ interface GetAddressOptions {
|
|
|
977
987
|
type AddressSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
|
|
978
988
|
interface AddressListParams extends ListParams<AddressSortBy> {
|
|
979
989
|
/** Returns addresses that have the provided discount_id. */
|
|
980
|
-
discount_id?: string;
|
|
990
|
+
discount_id?: string | number;
|
|
981
991
|
/** Returns addresses that have the provided discount_code. */
|
|
982
992
|
discount_code?: string;
|
|
983
993
|
/** Returns addresses created after the given time. */
|
|
@@ -1139,9 +1149,9 @@ interface BundleSelectionsResponse {
|
|
|
1139
1149
|
type BundleSelectionsSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
|
|
1140
1150
|
interface BundleSelectionListParams extends ListParams<BundleSelectionsSortBy> {
|
|
1141
1151
|
/** Filter BundleSelections by Subscription or Onetime ID. */
|
|
1142
|
-
purchase_item_ids?: string[];
|
|
1152
|
+
purchase_item_ids?: (string | number)[];
|
|
1143
1153
|
/** Filter BundleSelections by BundleVariants. */
|
|
1144
|
-
bundle_variant_ids?: string[];
|
|
1154
|
+
bundle_variant_ids?: (string | number)[];
|
|
1145
1155
|
}
|
|
1146
1156
|
|
|
1147
1157
|
type FirstOption = 'onetime' | 'autodeliver';
|
|
@@ -1529,7 +1539,7 @@ type MembershipIncludes = `${membershipIncludes}` | `${membershipIncludes},${mem
|
|
|
1529
1539
|
interface MembershipListParams extends ListParams<MembershipsSortBy> {
|
|
1530
1540
|
include?: MembershipIncludes;
|
|
1531
1541
|
/** Return the memberships linked to the given membership_program_ids. */
|
|
1532
|
-
membership_program_ids?: string[];
|
|
1542
|
+
membership_program_ids?: (string | number)[];
|
|
1533
1543
|
/** Return the memberships with specified status. */
|
|
1534
1544
|
status?: MembershipStatus;
|
|
1535
1545
|
/** Returns memberships created after the given time. */
|
|
@@ -1653,7 +1663,7 @@ type MembershipProgramIncludes = 'membership_benefits' | 'collections';
|
|
|
1653
1663
|
/** @internal */
|
|
1654
1664
|
interface MembershipProgramListParams extends ListParams<MembershipProgramSortBy> {
|
|
1655
1665
|
/** Return the membership program with specified IDs. */
|
|
1656
|
-
ids?: number[];
|
|
1666
|
+
ids?: (string | number)[];
|
|
1657
1667
|
/** Return the membership program with specified status. */
|
|
1658
1668
|
status?: MembershipProgramStatus;
|
|
1659
1669
|
/** If true the response will include the deleted membership programs as well as the others. */
|
|
@@ -1717,17 +1727,17 @@ interface OnetimesResponse {
|
|
|
1717
1727
|
type OnetimesSortBy = 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-asc' | 'updated_at-desc';
|
|
1718
1728
|
interface OnetimeListParams extends ListParams<OnetimesSortBy> {
|
|
1719
1729
|
/** Return the onetimes linked to the given address_id. */
|
|
1720
|
-
address_id?: string;
|
|
1730
|
+
address_id?: string | number;
|
|
1721
1731
|
/** Return the onetimes linked to the given address_ids. */
|
|
1722
|
-
address_ids?: string[];
|
|
1732
|
+
address_ids?: (string | number)[];
|
|
1723
1733
|
/** Return the onetimes created before the given date. */
|
|
1724
1734
|
created_at_max?: IsoDateString;
|
|
1725
1735
|
/** Return the onetimes created after the given date. */
|
|
1726
1736
|
created_at_min?: IsoDateString;
|
|
1727
1737
|
/** Return the onetimes linked to the given external_variant_id */
|
|
1728
|
-
external_variant_id?: string;
|
|
1738
|
+
external_variant_id?: string | number;
|
|
1729
1739
|
/** Comma-separated list of onetime_ids to filter */
|
|
1730
|
-
ids?: string[];
|
|
1740
|
+
ids?: (string | number)[];
|
|
1731
1741
|
/** If true the response will include the cancelled Onetimes as well as the others. */
|
|
1732
1742
|
include_cancelled?: boolean;
|
|
1733
1743
|
/** Return the onetimes updated before the given date. */
|
|
@@ -1827,7 +1837,7 @@ interface PlansResponse {
|
|
|
1827
1837
|
type PlanSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
|
|
1828
1838
|
interface PlanListParams extends ListParams<PlanSortBy> {
|
|
1829
1839
|
/** Return the Plans linked to the Product record in Recharge with the indicated external_product_id */
|
|
1830
|
-
external_product_id?: string;
|
|
1840
|
+
external_product_id?: string | number;
|
|
1831
1841
|
/** Return the plans updated before the given date. */
|
|
1832
1842
|
updated_at_max?: IsoDateString;
|
|
1833
1843
|
/** Return the plans updated after the given date. */
|