@simpleapps-com/augur-api 0.2.3 → 0.2.5
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/README.md +100 -0
- package/dist/cjs/client.d.ts +181 -0
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +449 -0
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/core/base-client.d.ts +104 -0
- package/dist/cjs/core/base-client.d.ts.map +1 -1
- package/dist/cjs/core/base-client.js +201 -0
- package/dist/cjs/core/base-client.js.map +1 -1
- package/dist/cjs/index.d.ts +2 -1
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/services/agr-site/client.d.ts +522 -2
- package/dist/cjs/services/agr-site/client.d.ts.map +1 -1
- package/dist/cjs/services/agr-site/client.js +565 -12
- package/dist/cjs/services/agr-site/client.js.map +1 -1
- package/dist/cjs/services/items/client.d.ts +2 -2
- package/dist/cjs/services/items/schemas/categories.d.ts +20 -20
- package/dist/cjs/services/joomla/client.d.ts +644 -99
- package/dist/cjs/services/joomla/client.d.ts.map +1 -1
- package/dist/cjs/services/joomla/client.js +467 -98
- package/dist/cjs/services/joomla/client.js.map +1 -1
- package/dist/cjs/services/nexus/client.d.ts +1096 -22
- package/dist/cjs/services/nexus/client.d.ts.map +1 -1
- package/dist/cjs/services/nexus/client.js +754 -22
- package/dist/cjs/services/nexus/client.js.map +1 -1
- package/dist/cjs/services/orders/client.d.ts +3 -3
- package/dist/cjs/services/orders/schemas/orders.d.ts +12 -12
- package/dist/cjs/services/orders/schemas/purchase-orders.d.ts +22 -22
- package/dist/cjs/services/p21-core/client.d.ts +627 -0
- package/dist/cjs/services/p21-core/client.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/client.js +704 -0
- package/dist/cjs/services/p21-core/client.js.map +1 -0
- package/dist/cjs/services/p21-core/index.d.ts +3 -0
- package/dist/cjs/services/p21-core/index.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/index.js +21 -0
- package/dist/cjs/services/p21-core/index.js.map +1 -0
- package/dist/cjs/services/p21-core/schemas/address.d.ts +88 -0
- package/dist/cjs/services/p21-core/schemas/address.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/schemas/address.js +45 -0
- package/dist/cjs/services/p21-core/schemas/address.js.map +1 -0
- package/dist/cjs/services/p21-core/schemas/cash-drawer.d.ts +96 -0
- package/dist/cjs/services/p21-core/schemas/cash-drawer.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/schemas/cash-drawer.js +39 -0
- package/dist/cjs/services/p21-core/schemas/cash-drawer.js.map +1 -0
- package/dist/cjs/services/p21-core/schemas/codes.d.ts +54 -0
- package/dist/cjs/services/p21-core/schemas/codes.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/schemas/codes.js +25 -0
- package/dist/cjs/services/p21-core/schemas/codes.js.map +1 -0
- package/dist/cjs/services/p21-core/schemas/company.d.ts +80 -0
- package/dist/cjs/services/p21-core/schemas/company.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/schemas/company.js +35 -0
- package/dist/cjs/services/p21-core/schemas/company.js.map +1 -0
- package/dist/cjs/services/p21-core/schemas/health.d.ts +46 -0
- package/dist/cjs/services/p21-core/schemas/health.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/schemas/health.js +7 -0
- package/dist/cjs/services/p21-core/schemas/health.js.map +1 -0
- package/dist/cjs/services/p21-core/schemas/index.d.ts +8 -0
- package/dist/cjs/services/p21-core/schemas/index.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/schemas/index.js +25 -0
- package/dist/cjs/services/p21-core/schemas/index.js.map +1 -0
- package/dist/cjs/services/p21-core/schemas/location.d.ts +84 -0
- package/dist/cjs/services/p21-core/schemas/location.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/schemas/location.js +35 -0
- package/dist/cjs/services/p21-core/schemas/location.js.map +1 -0
- package/dist/cjs/services/p21-core/schemas/payment-types.d.ts +39 -0
- package/dist/cjs/services/p21-core/schemas/payment-types.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/schemas/payment-types.js +26 -0
- package/dist/cjs/services/p21-core/schemas/payment-types.js.map +1 -0
- package/dist/cjs/services/p21-core/schemas.d.ts +2 -0
- package/dist/cjs/services/p21-core/schemas.d.ts.map +1 -0
- package/dist/cjs/services/p21-core/schemas.js +19 -0
- package/dist/cjs/services/p21-core/schemas.js.map +1 -0
- package/dist/cjs/services/vmi/schemas/inventory.d.ts +6 -6
- package/dist/cjs/services/vmi/schemas/products.d.ts +6 -6
- package/dist/cjs/services/vmi/schemas/restock.d.ts +12 -12
- package/dist/esm/client.d.ts +181 -0
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +449 -0
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/core/base-client.d.ts +104 -0
- package/dist/esm/core/base-client.d.ts.map +1 -1
- package/dist/esm/core/base-client.js +201 -0
- package/dist/esm/core/base-client.js.map +1 -1
- package/dist/esm/index.d.ts +2 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/services/agr-site/client.d.ts +522 -2
- package/dist/esm/services/agr-site/client.d.ts.map +1 -1
- package/dist/esm/services/agr-site/client.js +565 -12
- package/dist/esm/services/agr-site/client.js.map +1 -1
- package/dist/esm/services/items/client.d.ts +2 -2
- package/dist/esm/services/items/schemas/categories.d.ts +20 -20
- package/dist/esm/services/joomla/client.d.ts +644 -99
- package/dist/esm/services/joomla/client.d.ts.map +1 -1
- package/dist/esm/services/joomla/client.js +467 -98
- package/dist/esm/services/joomla/client.js.map +1 -1
- package/dist/esm/services/nexus/client.d.ts +1096 -22
- package/dist/esm/services/nexus/client.d.ts.map +1 -1
- package/dist/esm/services/nexus/client.js +754 -22
- package/dist/esm/services/nexus/client.js.map +1 -1
- package/dist/esm/services/orders/client.d.ts +3 -3
- package/dist/esm/services/orders/schemas/orders.d.ts +12 -12
- package/dist/esm/services/orders/schemas/purchase-orders.d.ts +22 -22
- package/dist/esm/services/p21-core/client.d.ts +627 -0
- package/dist/esm/services/p21-core/client.d.ts.map +1 -0
- package/dist/esm/services/p21-core/client.js +700 -0
- package/dist/esm/services/p21-core/client.js.map +1 -0
- package/dist/esm/services/p21-core/index.d.ts +3 -0
- package/dist/esm/services/p21-core/index.d.ts.map +1 -0
- package/dist/esm/services/p21-core/index.js +3 -0
- package/dist/esm/services/p21-core/index.js.map +1 -0
- package/dist/esm/services/p21-core/schemas/address.d.ts +88 -0
- package/dist/esm/services/p21-core/schemas/address.d.ts.map +1 -0
- package/dist/esm/services/p21-core/schemas/address.js +42 -0
- package/dist/esm/services/p21-core/schemas/address.js.map +1 -0
- package/dist/esm/services/p21-core/schemas/cash-drawer.d.ts +96 -0
- package/dist/esm/services/p21-core/schemas/cash-drawer.d.ts.map +1 -0
- package/dist/esm/services/p21-core/schemas/cash-drawer.js +36 -0
- package/dist/esm/services/p21-core/schemas/cash-drawer.js.map +1 -0
- package/dist/esm/services/p21-core/schemas/codes.d.ts +54 -0
- package/dist/esm/services/p21-core/schemas/codes.d.ts.map +1 -0
- package/dist/esm/services/p21-core/schemas/codes.js +22 -0
- package/dist/esm/services/p21-core/schemas/codes.js.map +1 -0
- package/dist/esm/services/p21-core/schemas/company.d.ts +80 -0
- package/dist/esm/services/p21-core/schemas/company.d.ts.map +1 -0
- package/dist/esm/services/p21-core/schemas/company.js +32 -0
- package/dist/esm/services/p21-core/schemas/company.js.map +1 -0
- package/dist/esm/services/p21-core/schemas/health.d.ts +46 -0
- package/dist/esm/services/p21-core/schemas/health.d.ts.map +1 -0
- package/dist/esm/services/p21-core/schemas/health.js +4 -0
- package/dist/esm/services/p21-core/schemas/health.js.map +1 -0
- package/dist/esm/services/p21-core/schemas/index.d.ts +8 -0
- package/dist/esm/services/p21-core/schemas/index.d.ts.map +1 -0
- package/dist/esm/services/p21-core/schemas/index.js +9 -0
- package/dist/esm/services/p21-core/schemas/index.js.map +1 -0
- package/dist/esm/services/p21-core/schemas/location.d.ts +84 -0
- package/dist/esm/services/p21-core/schemas/location.d.ts.map +1 -0
- package/dist/esm/services/p21-core/schemas/location.js +32 -0
- package/dist/esm/services/p21-core/schemas/location.js.map +1 -0
- package/dist/esm/services/p21-core/schemas/payment-types.d.ts +39 -0
- package/dist/esm/services/p21-core/schemas/payment-types.d.ts.map +1 -0
- package/dist/esm/services/p21-core/schemas/payment-types.js +23 -0
- package/dist/esm/services/p21-core/schemas/payment-types.js.map +1 -0
- package/dist/esm/services/p21-core/schemas.d.ts +2 -0
- package/dist/esm/services/p21-core/schemas.d.ts.map +1 -0
- package/dist/esm/services/p21-core/schemas.js +3 -0
- package/dist/esm/services/p21-core/schemas.js.map +1 -0
- package/dist/esm/services/vmi/schemas/inventory.d.ts +6 -6
- package/dist/esm/services/vmi/schemas/products.d.ts +6 -6
- package/dist/esm/services/vmi/schemas/restock.d.ts +12 -12
- package/dist/types/client.d.ts +181 -0
- package/dist/types/client.d.ts.map +1 -1
- package/dist/types/core/base-client.d.ts +104 -0
- package/dist/types/core/base-client.d.ts.map +1 -1
- package/dist/types/index.d.ts +2 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/services/agr-site/client.d.ts +522 -2
- package/dist/types/services/agr-site/client.d.ts.map +1 -1
- package/dist/types/services/items/client.d.ts +2 -2
- package/dist/types/services/items/schemas/categories.d.ts +20 -20
- package/dist/types/services/joomla/client.d.ts +644 -99
- package/dist/types/services/joomla/client.d.ts.map +1 -1
- package/dist/types/services/nexus/client.d.ts +1096 -22
- package/dist/types/services/nexus/client.d.ts.map +1 -1
- package/dist/types/services/orders/client.d.ts +3 -3
- package/dist/types/services/orders/schemas/orders.d.ts +12 -12
- package/dist/types/services/orders/schemas/purchase-orders.d.ts +22 -22
- package/dist/types/services/p21-core/client.d.ts +627 -0
- package/dist/types/services/p21-core/client.d.ts.map +1 -0
- package/dist/types/services/p21-core/index.d.ts +3 -0
- package/dist/types/services/p21-core/index.d.ts.map +1 -0
- package/dist/types/services/p21-core/schemas/address.d.ts +88 -0
- package/dist/types/services/p21-core/schemas/address.d.ts.map +1 -0
- package/dist/types/services/p21-core/schemas/cash-drawer.d.ts +96 -0
- package/dist/types/services/p21-core/schemas/cash-drawer.d.ts.map +1 -0
- package/dist/types/services/p21-core/schemas/codes.d.ts +54 -0
- package/dist/types/services/p21-core/schemas/codes.d.ts.map +1 -0
- package/dist/types/services/p21-core/schemas/company.d.ts +80 -0
- package/dist/types/services/p21-core/schemas/company.d.ts.map +1 -0
- package/dist/types/services/p21-core/schemas/health.d.ts +46 -0
- package/dist/types/services/p21-core/schemas/health.d.ts.map +1 -0
- package/dist/types/services/p21-core/schemas/index.d.ts +8 -0
- package/dist/types/services/p21-core/schemas/index.d.ts.map +1 -0
- package/dist/types/services/p21-core/schemas/location.d.ts +84 -0
- package/dist/types/services/p21-core/schemas/location.d.ts.map +1 -0
- package/dist/types/services/p21-core/schemas/payment-types.d.ts +39 -0
- package/dist/types/services/p21-core/schemas/payment-types.d.ts.map +1 -0
- package/dist/types/services/p21-core/schemas.d.ts +2 -0
- package/dist/types/services/p21-core/schemas.d.ts.map +1 -0
- package/dist/types/services/vmi/schemas/inventory.d.ts +6 -6
- package/dist/types/services/vmi/schemas/products.d.ts +6 -6
- package/dist/types/services/vmi/schemas/restock.d.ts +12 -12
- package/package.json +1 -1
|
@@ -0,0 +1,627 @@
|
|
|
1
|
+
import { HTTPClient } from '../../core/client';
|
|
2
|
+
import { BaseServiceClient, type BaseResponse } from '../../core/base-client';
|
|
3
|
+
import { type AddressListParams, type AddressCorpListParams, type AddressEnableParams, type CashDrawerListParams, type CompanyListParams, type CompanyDetailParams, type P21CodeListParams, type LocationListParams, type PaymentTypeListParams } from './schemas';
|
|
4
|
+
/**
|
|
5
|
+
* P21 Core API Client
|
|
6
|
+
* @description Client for interacting with P21 Core system API endpoints for address management, cash drawer operations, company data, location management, and payment processing within the Prophet 21 ERP system
|
|
7
|
+
* @fullPath api.p21Core
|
|
8
|
+
* @service p21-core
|
|
9
|
+
* @domain enterprise-resource-planning
|
|
10
|
+
* @discoverable true
|
|
11
|
+
* @searchTerms ["p21-core", "prophet 21", "ERP", "addresses", "cash drawer", "company data", "locations", "payment types", "shipping methods", "business operations", "corporate addresses"]
|
|
12
|
+
* @relatedEndpoints ["api.p21Core.address", "api.p21Core.cashDrawer", "api.p21Core.company", "api.p21Core.location", "api.p21Core.paymentTypes", "api.p21Core.codes"]
|
|
13
|
+
* @commonPatterns ["ERP data management", "Address and shipping setup", "Cash drawer operations", "Company configuration", "Location management", "Payment processing setup"]
|
|
14
|
+
* @workflow ["erp-setup", "address-management", "financial-operations", "location-configuration", "payment-processing"]
|
|
15
|
+
* @prerequisites ["Valid P21 system access", "ERP authentication", "Company-specific permissions"]
|
|
16
|
+
* @nextSteps ["api.commerce.cartHeaders for e-commerce integration", "api.orders for order processing", "api.pricing for pricing management"]
|
|
17
|
+
* @businessRules ["Company-scoped data access", "Location-based permissions", "Cash drawer security controls", "Address validation for shipping"]
|
|
18
|
+
* @functionalArea "enterprise-resource-planning"
|
|
19
|
+
* @caching "Cache company and location data for 30 minutes, real-time for cash drawer operations"
|
|
20
|
+
* @performance "Supports pagination for all list operations, optimized for ERP transaction volumes"
|
|
21
|
+
* @example
|
|
22
|
+
* ```typescript
|
|
23
|
+
* import { HTTPClient } from '@augur/api-client/core';
|
|
24
|
+
* import { P21CoreClient } from '@augur/api-client/services/p21-core';
|
|
25
|
+
*
|
|
26
|
+
* const client = new P21CoreClient(new HTTPClient({ baseURL: 'https://p21-core.augur-api.com' }));
|
|
27
|
+
*
|
|
28
|
+
* // List companies with pagination
|
|
29
|
+
* const companies = await client.company.list({ limit: 20, offset: 0 });
|
|
30
|
+
* console.log(companies.data); // Company[]
|
|
31
|
+
*
|
|
32
|
+
* // Get company details
|
|
33
|
+
* const company = await client.company.get({ companyUid: 123 });
|
|
34
|
+
* console.log(company.data); // Company
|
|
35
|
+
*
|
|
36
|
+
* // List addresses for shipping configuration
|
|
37
|
+
* const addresses = await client.address.list({ carrierFlag: 'Y' });
|
|
38
|
+
* console.log(addresses.data); // Address[]
|
|
39
|
+
*
|
|
40
|
+
* // Get cash drawer status
|
|
41
|
+
* const cashDrawers = await client.cashDrawer.list({ statusCd: 704 });
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
export declare class P21CoreClient extends BaseServiceClient {
|
|
45
|
+
private readonly _schemaRefs;
|
|
46
|
+
private get schemaRefs();
|
|
47
|
+
/**
|
|
48
|
+
* Create a new P21CoreClient instance
|
|
49
|
+
* @param http Configured HTTPClient instance with authentication
|
|
50
|
+
* @param baseUrl Base URL for the P21 Core API (default: https://p21-core.augur-api.com)
|
|
51
|
+
*/
|
|
52
|
+
constructor(http: HTTPClient, baseUrl?: string);
|
|
53
|
+
/**
|
|
54
|
+
* Address management operations for shipping and delivery configuration
|
|
55
|
+
* @fullPath api.p21Core.address
|
|
56
|
+
* @service p21-core
|
|
57
|
+
* @domain address-and-shipping-management
|
|
58
|
+
* @discoverable true
|
|
59
|
+
*/
|
|
60
|
+
readonly address: {
|
|
61
|
+
/**
|
|
62
|
+
* List all addresses with filtering capabilities for shipping method configuration
|
|
63
|
+
*
|
|
64
|
+
* @fullPath api.p21Core.address.list
|
|
65
|
+
* @service p21-core
|
|
66
|
+
* @domain address-and-shipping-management
|
|
67
|
+
* @dataMethod listData - returns only the address array without metadata
|
|
68
|
+
* @discoverable true
|
|
69
|
+
* @searchTerms ["addresses", "shipping", "delivery", "locations", "carriers", "shipping methods"]
|
|
70
|
+
* @relatedEndpoints ["api.p21Core.address.get", "api.p21Core.location.list", "api.commerce.cartHeaders.shipping"]
|
|
71
|
+
* @commonPatterns ["List shipping addresses", "Configure delivery options", "Manage carrier settings"]
|
|
72
|
+
* @workflow ["address-setup", "shipping-configuration", "delivery-management"]
|
|
73
|
+
* @prerequisites ["Valid authentication", "Address management permissions"]
|
|
74
|
+
* @nextSteps ["api.p21Core.address.get for details", "api.p21Core.address.enable for activation"]
|
|
75
|
+
* @businessRules ["Carrier flag controls shipping availability", "Status codes determine address visibility", "Default codes set primary shipping methods"]
|
|
76
|
+
* @functionalArea "address-and-shipping-management"
|
|
77
|
+
* @caching "Cache for 15 minutes, invalidate on address changes"
|
|
78
|
+
* @performance "Supports filtering by carrier, status, and default flags for efficient queries"
|
|
79
|
+
*
|
|
80
|
+
* @param params Optional filtering parameters for addresses
|
|
81
|
+
* @returns Promise<BaseResponse<Address[]>> Complete response with addresses array and metadata
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```typescript
|
|
85
|
+
* // Get all active shipping addresses
|
|
86
|
+
* const response = await client.address.list({ carrierFlag: 'Y', statusCd: 704 });
|
|
87
|
+
* console.log(response.data); // Address[]
|
|
88
|
+
*
|
|
89
|
+
* // Get just the data
|
|
90
|
+
* const addresses = await client.address.listData({ enabledCd: 704 });
|
|
91
|
+
*
|
|
92
|
+
* // Get default shipping methods
|
|
93
|
+
* const defaults = await client.address.list({ defaultCd: 704 });
|
|
94
|
+
* ```
|
|
95
|
+
*/
|
|
96
|
+
list: (params?: {
|
|
97
|
+
limit?: number | undefined;
|
|
98
|
+
offset?: number | undefined;
|
|
99
|
+
statusCd?: number | undefined;
|
|
100
|
+
carrierFlag?: string | undefined;
|
|
101
|
+
defaultCd?: number | undefined;
|
|
102
|
+
enabledCd?: number | undefined;
|
|
103
|
+
} | undefined) => Promise<BaseResponse<unknown[]>>;
|
|
104
|
+
/**
|
|
105
|
+
* Get address details by ID for shipping method configuration
|
|
106
|
+
*
|
|
107
|
+
* @fullPath api.p21Core.address.get
|
|
108
|
+
* @service p21-core
|
|
109
|
+
* @domain address-and-shipping-management
|
|
110
|
+
* @dataMethod getData - returns only the address object without metadata
|
|
111
|
+
* @discoverable true
|
|
112
|
+
* @searchTerms ["address details", "shipping method", "delivery configuration", "carrier info"]
|
|
113
|
+
* @relatedEndpoints ["api.p21Core.address.list", "api.p21Core.address.corpAddressList", "api.p21Core.location.get"]
|
|
114
|
+
* @commonPatterns ["Get shipping address details", "View delivery configuration", "Check carrier settings"]
|
|
115
|
+
* @workflow ["address-details", "shipping-setup", "delivery-configuration"]
|
|
116
|
+
* @prerequisites ["Valid address ID", "Address access permissions"]
|
|
117
|
+
* @nextSteps ["api.p21Core.address.enable for status changes", "api.p21Core.address.setDefault for primary selection"]
|
|
118
|
+
* @businessRules ["Address ID must exist in system", "User must have access to address company"]
|
|
119
|
+
* @functionalArea "address-and-shipping-management"
|
|
120
|
+
* @performance "Direct lookup by ID, very fast response"
|
|
121
|
+
*
|
|
122
|
+
* @param params Address ID parameter
|
|
123
|
+
* @returns Promise<BaseResponse<Address>> Complete response with address details
|
|
124
|
+
*/
|
|
125
|
+
get: (params: {
|
|
126
|
+
id: number;
|
|
127
|
+
}) => Promise<BaseResponse<unknown>>;
|
|
128
|
+
/**
|
|
129
|
+
* Get corporate address list for multi-location shipping setup
|
|
130
|
+
*
|
|
131
|
+
* @fullPath api.p21Core.address.corpAddressList
|
|
132
|
+
* @service p21-core
|
|
133
|
+
* @domain address-and-shipping-management
|
|
134
|
+
* @dataMethod corpAddressListData - returns only the corporate addresses array
|
|
135
|
+
* @discoverable true
|
|
136
|
+
* @searchTerms ["corporate addresses", "multi-location", "branch shipping", "company locations"]
|
|
137
|
+
* @relatedEndpoints ["api.p21Core.address.get", "api.p21Core.company.list", "api.p21Core.location.list"]
|
|
138
|
+
* @commonPatterns ["Setup multi-location shipping", "Configure branch addresses", "Manage corporate locations"]
|
|
139
|
+
* @workflow ["multi-location-setup", "corporate-shipping", "branch-management"]
|
|
140
|
+
* @prerequisites ["Valid address ID", "Corporate address access permissions"]
|
|
141
|
+
* @nextSteps ["api.p21Core.location.list for location details", "api.p21Core.company.get for company info"]
|
|
142
|
+
* @businessRules ["Returns addresses associated with specified location", "Supports search filtering", "Pagination for large datasets"]
|
|
143
|
+
* @functionalArea "address-and-shipping-management"
|
|
144
|
+
* @caching "Cache for 20 minutes, corporate addresses change infrequently"
|
|
145
|
+
* @performance "Indexed by address ID and company, supports text search"
|
|
146
|
+
*/
|
|
147
|
+
corpAddressList: (params: AddressCorpListParams) => Promise<BaseResponse<unknown[]>>;
|
|
148
|
+
/**
|
|
149
|
+
* Set address as default shipping method for automated selection
|
|
150
|
+
*
|
|
151
|
+
* @fullPath api.p21Core.address.setDefault
|
|
152
|
+
* @service p21-core
|
|
153
|
+
* @domain address-and-shipping-management
|
|
154
|
+
* @dataMethod setDefaultData - returns confirmation without metadata
|
|
155
|
+
* @discoverable true
|
|
156
|
+
* @searchTerms ["default shipping", "primary address", "automatic selection", "shipping defaults"]
|
|
157
|
+
* @relatedEndpoints ["api.p21Core.address.list", "api.p21Core.address.enable", "api.commerce.cartHeaders.defaultShipping"]
|
|
158
|
+
* @commonPatterns ["Set primary shipping method", "Configure automatic selection", "Update default address"]
|
|
159
|
+
* @workflow ["shipping-defaults", "address-configuration", "automatic-selection"]
|
|
160
|
+
* @prerequisites ["Valid address ID", "Address modification permissions"]
|
|
161
|
+
* @nextSteps ["api.p21Core.address.list to verify changes", "api.commerce.cartHeaders for cart integration"]
|
|
162
|
+
* @businessRules ["Only one default per address type", "Must be enabled address", "Updates system-wide defaults"]
|
|
163
|
+
* @functionalArea "address-and-shipping-management"
|
|
164
|
+
* @performance "Immediate update with cache invalidation"
|
|
165
|
+
*/
|
|
166
|
+
setDefault: (params: {
|
|
167
|
+
id: number;
|
|
168
|
+
}) => Promise<BaseResponse<unknown>>;
|
|
169
|
+
/**
|
|
170
|
+
* Enable or disable address as shipping method for availability control
|
|
171
|
+
*
|
|
172
|
+
* @fullPath api.p21Core.address.enable
|
|
173
|
+
* @service p21-core
|
|
174
|
+
* @domain address-and-shipping-management
|
|
175
|
+
* @dataMethod enableData - returns status confirmation without metadata
|
|
176
|
+
* @discoverable true
|
|
177
|
+
* @searchTerms ["enable address", "disable shipping", "address status", "shipping availability"]
|
|
178
|
+
* @relatedEndpoints ["api.p21Core.address.list", "api.p21Core.address.setDefault", "api.commerce.cartHeaders.availableShipping"]
|
|
179
|
+
* @commonPatterns ["Enable shipping method", "Disable delivery option", "Control address availability"]
|
|
180
|
+
* @workflow ["address-activation", "shipping-control", "availability-management"]
|
|
181
|
+
* @prerequisites ["Valid address ID", "Address modification permissions"]
|
|
182
|
+
* @nextSteps ["api.p21Core.address.list to verify status", "api.p21Core.address.setDefault if enabling primary"]
|
|
183
|
+
* @businessRules ["Status codes: 704=enabled, 705=disabled, blank=inherited", "Disabled addresses hidden from selection", "Status affects availability in e-commerce"]
|
|
184
|
+
* @functionalArea "address-and-shipping-management"
|
|
185
|
+
* @performance "Immediate status update with real-time availability"
|
|
186
|
+
*/
|
|
187
|
+
enable: (params: AddressEnableParams) => Promise<BaseResponse<unknown>>;
|
|
188
|
+
/**
|
|
189
|
+
* Trigger data refresh for address synchronization
|
|
190
|
+
*
|
|
191
|
+
* @fullPath api.p21Core.address.refresh
|
|
192
|
+
* @service p21-core
|
|
193
|
+
* @domain address-and-shipping-management
|
|
194
|
+
* @dataMethod refreshData - returns refresh status without metadata
|
|
195
|
+
* @discoverable true
|
|
196
|
+
* @searchTerms ["refresh addresses", "sync data", "update cache", "data synchronization"]
|
|
197
|
+
* @relatedEndpoints ["api.p21Core.address.list", "api.p21Core.health.check"]
|
|
198
|
+
* @commonPatterns ["Sync address data", "Refresh shipping options", "Update cached information"]
|
|
199
|
+
* @workflow ["data-synchronization", "cache-refresh", "system-maintenance"]
|
|
200
|
+
* @prerequisites ["System admin permissions", "Data refresh authorization"]
|
|
201
|
+
* @nextSteps ["api.p21Core.address.list to verify updated data"]
|
|
202
|
+
* @businessRules ["Triggers background synchronization", "May take time for large datasets", "Updates all address-related caches"]
|
|
203
|
+
* @functionalArea "address-and-shipping-management"
|
|
204
|
+
* @performance "Asynchronous operation, returns immediately"
|
|
205
|
+
*/
|
|
206
|
+
refresh: () => Promise<BaseResponse<unknown>>;
|
|
207
|
+
listData: (params?: AddressListParams) => Promise<unknown[]>;
|
|
208
|
+
getData: (params: {
|
|
209
|
+
id: number;
|
|
210
|
+
}) => Promise<unknown>;
|
|
211
|
+
corpAddressListData: (params: AddressCorpListParams) => Promise<unknown[]>;
|
|
212
|
+
setDefaultData: (params: {
|
|
213
|
+
id: number;
|
|
214
|
+
}) => Promise<unknown>;
|
|
215
|
+
enableData: (params: AddressEnableParams) => Promise<unknown>;
|
|
216
|
+
refreshData: () => Promise<unknown>;
|
|
217
|
+
};
|
|
218
|
+
/**
|
|
219
|
+
* Cash drawer management operations for point-of-sale and financial transactions
|
|
220
|
+
* @fullPath api.p21Core.cashDrawer
|
|
221
|
+
* @service p21-core
|
|
222
|
+
* @domain financial-and-pos-management
|
|
223
|
+
* @discoverable true
|
|
224
|
+
*/
|
|
225
|
+
readonly cashDrawer: {
|
|
226
|
+
/**
|
|
227
|
+
* List cash drawers with filtering for financial management and POS operations
|
|
228
|
+
*
|
|
229
|
+
* @fullPath api.p21Core.cashDrawer.list
|
|
230
|
+
* @service p21-core
|
|
231
|
+
* @domain financial-and-pos-management
|
|
232
|
+
* @dataMethod listData - returns only the cash drawer array without metadata
|
|
233
|
+
* @discoverable true
|
|
234
|
+
* @searchTerms ["cash drawers", "point of sale", "POS", "financial", "cash management", "drawer operations"]
|
|
235
|
+
* @relatedEndpoints ["api.p21Core.cashDrawer.get", "api.p21Core.company.list", "api.orders.invoices.list"]
|
|
236
|
+
* @commonPatterns ["List POS cash drawers", "Financial drawer management", "Cash operation monitoring"]
|
|
237
|
+
* @workflow ["pos-operations", "cash-management", "financial-reconciliation"]
|
|
238
|
+
* @prerequisites ["Valid authentication", "Cash drawer access permissions", "Company access rights"]
|
|
239
|
+
* @nextSteps ["api.p21Core.cashDrawer.get for details", "api.orders.invoices for transaction history"]
|
|
240
|
+
* @businessRules ["Status codes control drawer availability", "Company ID filters by location", "Drawer open status affects operations"]
|
|
241
|
+
* @functionalArea "financial-and-pos-management"
|
|
242
|
+
* @caching "Cache for 5 minutes only, financial data needs freshness"
|
|
243
|
+
* @performance "Real-time queries for accurate cash positions, supports company filtering"
|
|
244
|
+
*
|
|
245
|
+
* @param params Optional filtering parameters for cash drawers
|
|
246
|
+
* @returns Promise<BaseResponse<CashDrawer[]>> Complete response with cash drawer array and metadata
|
|
247
|
+
*
|
|
248
|
+
* @example
|
|
249
|
+
* ```typescript
|
|
250
|
+
* // Get active cash drawers for a company
|
|
251
|
+
* const response = await client.cashDrawer.list({ companyId: 'MAIN', statusCd: 704 });
|
|
252
|
+
* console.log(response.data); // CashDrawer[]
|
|
253
|
+
*
|
|
254
|
+
* // Get just the data
|
|
255
|
+
* const drawers = await client.cashDrawer.listData({ statusCd: 704 });
|
|
256
|
+
*
|
|
257
|
+
* // Search for specific drawer
|
|
258
|
+
* const found = await client.cashDrawer.list({ q: 'register1' });
|
|
259
|
+
* ```
|
|
260
|
+
*/
|
|
261
|
+
list: (params?: {
|
|
262
|
+
limit?: number | undefined;
|
|
263
|
+
offset?: number | undefined;
|
|
264
|
+
q?: string | undefined;
|
|
265
|
+
orderBy?: string | undefined;
|
|
266
|
+
statusCd?: number | undefined;
|
|
267
|
+
companyId?: string | undefined;
|
|
268
|
+
} | undefined) => Promise<BaseResponse<unknown[]>>;
|
|
269
|
+
/**
|
|
270
|
+
* Get cash drawer details by UID for detailed financial information
|
|
271
|
+
*
|
|
272
|
+
* @fullPath api.p21Core.cashDrawer.get
|
|
273
|
+
* @service p21-core
|
|
274
|
+
* @domain financial-and-pos-management
|
|
275
|
+
* @dataMethod getData - returns only the cash drawer object without metadata
|
|
276
|
+
* @discoverable true
|
|
277
|
+
* @searchTerms ["cash drawer details", "POS details", "financial balance", "drawer status", "cash position"]
|
|
278
|
+
* @relatedEndpoints ["api.p21Core.cashDrawer.list", "api.orders.invoices.cashTransactions", "api.p21Core.company.get"]
|
|
279
|
+
* @commonPatterns ["Get drawer balance", "Check cash position", "View POS status", "Financial reconciliation"]
|
|
280
|
+
* @workflow ["cash-operations", "financial-reporting", "pos-management", "drawer-reconciliation"]
|
|
281
|
+
* @prerequisites ["Valid cash drawer UID", "Financial access permissions"]
|
|
282
|
+
* @nextSteps ["api.orders.invoices for transaction details", "financial reporting systems"]
|
|
283
|
+
* @businessRules ["Real-time balance calculations", "Includes opening balance, deposits, withdrawals", "Shows current drawer status (open/closed)"]
|
|
284
|
+
* @functionalArea "financial-and-pos-management"
|
|
285
|
+
* @performance "Direct lookup by UID, includes calculated balances"
|
|
286
|
+
*
|
|
287
|
+
* @param params Cash drawer UID parameter
|
|
288
|
+
* @returns Promise<BaseResponse<CashDrawer>> Complete response with cash drawer details including balances
|
|
289
|
+
*/
|
|
290
|
+
get: (params: {
|
|
291
|
+
cashDrawerUid: number;
|
|
292
|
+
}) => Promise<BaseResponse<unknown>>;
|
|
293
|
+
listData: (params?: CashDrawerListParams) => Promise<unknown[]>;
|
|
294
|
+
getData: (params: {
|
|
295
|
+
cashDrawerUid: number;
|
|
296
|
+
}) => Promise<unknown>;
|
|
297
|
+
};
|
|
298
|
+
/**
|
|
299
|
+
* Company management operations for enterprise configuration and corporate data
|
|
300
|
+
* @fullPath api.p21Core.company
|
|
301
|
+
* @service p21-core
|
|
302
|
+
* @domain company-and-corporate-management
|
|
303
|
+
* @discoverable true
|
|
304
|
+
*/
|
|
305
|
+
readonly company: {
|
|
306
|
+
/**
|
|
307
|
+
* List companies with filtering for enterprise management and corporate structure
|
|
308
|
+
*
|
|
309
|
+
* @fullPath api.p21Core.company.list
|
|
310
|
+
* @service p21-core
|
|
311
|
+
* @domain company-and-corporate-management
|
|
312
|
+
* @dataMethod listData - returns only the company array without metadata
|
|
313
|
+
* @discoverable true
|
|
314
|
+
* @searchTerms ["companies", "corporate", "enterprise", "business entities", "organizations", "company list"]
|
|
315
|
+
* @relatedEndpoints ["api.p21Core.company.get", "api.p21Core.location.list", "api.customers.customer.list"]
|
|
316
|
+
* @commonPatterns ["List corporate entities", "Enterprise structure management", "Company directory", "Business organization"]
|
|
317
|
+
* @workflow ["corporate-setup", "enterprise-management", "business-configuration", "multi-company-operations"]
|
|
318
|
+
* @prerequisites ["Valid authentication", "Company access permissions"]
|
|
319
|
+
* @nextSteps ["api.p21Core.company.get for details", "api.p21Core.location.list for company locations"]
|
|
320
|
+
* @businessRules ["Company ID filtering by access rights", "Search supports company name and ID", "Ordering by UID or custom fields"]
|
|
321
|
+
* @functionalArea "company-and-corporate-management"
|
|
322
|
+
* @caching "Cache for 30 minutes, company data changes infrequently"
|
|
323
|
+
* @performance "Indexed by company ID and name, supports text search and sorting"
|
|
324
|
+
*
|
|
325
|
+
* @param params Optional filtering and pagination parameters
|
|
326
|
+
* @returns Promise<BaseResponse<Company[]>> Complete response with company array and metadata
|
|
327
|
+
*
|
|
328
|
+
* @example
|
|
329
|
+
* ```typescript
|
|
330
|
+
* // Get all companies with pagination
|
|
331
|
+
* const response = await client.company.list({ limit: 50, offset: 0 });
|
|
332
|
+
* console.log(response.data); // Company[]
|
|
333
|
+
*
|
|
334
|
+
* // Get just the data
|
|
335
|
+
* const companies = await client.company.listData();
|
|
336
|
+
*
|
|
337
|
+
* // Search for specific company
|
|
338
|
+
* const found = await client.company.list({ q: 'Acme Corp' });
|
|
339
|
+
*
|
|
340
|
+
* // Filter by company ID
|
|
341
|
+
* const specific = await client.company.list({ companyId: 'ACME' });
|
|
342
|
+
* ```
|
|
343
|
+
*/
|
|
344
|
+
list: (params?: {
|
|
345
|
+
limit?: number | undefined;
|
|
346
|
+
offset?: number | undefined;
|
|
347
|
+
q?: string | undefined;
|
|
348
|
+
orderBy?: string | undefined;
|
|
349
|
+
companyId?: string | undefined;
|
|
350
|
+
} | undefined) => Promise<BaseResponse<unknown[]>>;
|
|
351
|
+
/**
|
|
352
|
+
* Get company details by UID for detailed corporate information
|
|
353
|
+
*
|
|
354
|
+
* @fullPath api.p21Core.company.get
|
|
355
|
+
* @service p21-core
|
|
356
|
+
* @domain company-and-corporate-management
|
|
357
|
+
* @dataMethod getData - returns only the company object without metadata
|
|
358
|
+
* @discoverable true
|
|
359
|
+
* @searchTerms ["company details", "corporate info", "business entity", "organization details", "company profile"]
|
|
360
|
+
* @relatedEndpoints ["api.p21Core.company.list", "api.p21Core.location.list", "api.customers.customer.companyCustomers"]
|
|
361
|
+
* @commonPatterns ["Get corporate details", "View business information", "Company profile lookup", "Enterprise configuration"]
|
|
362
|
+
* @workflow ["company-details", "corporate-profile", "business-configuration", "enterprise-setup"]
|
|
363
|
+
* @prerequisites ["Valid company UID", "Company access permissions"]
|
|
364
|
+
* @nextSteps ["api.p21Core.location.list for company locations", "api.customers.customer.list for company customers"]
|
|
365
|
+
* @businessRules ["Company UID must exist", "Optional company ID parameter for validation", "Includes address and location references"]
|
|
366
|
+
* @functionalArea "company-and-corporate-management"
|
|
367
|
+
* @performance "Direct lookup by UID, includes related entity references"
|
|
368
|
+
*
|
|
369
|
+
* @param params Company UID and optional company ID
|
|
370
|
+
* @returns Promise<BaseResponse<Company>> Complete response with detailed company information
|
|
371
|
+
*/
|
|
372
|
+
get: (params: CompanyDetailParams) => Promise<BaseResponse<unknown>>;
|
|
373
|
+
listData: (params?: CompanyListParams) => Promise<unknown[]>;
|
|
374
|
+
getData: (params: CompanyDetailParams) => Promise<unknown>;
|
|
375
|
+
};
|
|
376
|
+
/**
|
|
377
|
+
* P21 system codes and reference data operations
|
|
378
|
+
* @fullPath api.p21Core.codes
|
|
379
|
+
* @service p21-core
|
|
380
|
+
* @domain system-configuration
|
|
381
|
+
* @discoverable true
|
|
382
|
+
*/
|
|
383
|
+
readonly codes: {
|
|
384
|
+
/**
|
|
385
|
+
* Search P21 system codes for configuration and reference data lookup
|
|
386
|
+
*
|
|
387
|
+
* @fullPath api.p21Core.codes.search
|
|
388
|
+
* @service p21-core
|
|
389
|
+
* @domain system-configuration
|
|
390
|
+
* @dataMethod searchData - returns only the codes array without metadata
|
|
391
|
+
* @discoverable true
|
|
392
|
+
* @searchTerms ["P21 codes", "system codes", "reference data", "configuration codes", "lookup values"]
|
|
393
|
+
* @relatedEndpoints ["api.p21Core.company.list", "api.p21Core.location.list", "api.items.categories.list"]
|
|
394
|
+
* @commonPatterns ["Lookup system codes", "Reference data search", "Configuration values", "Code validation"]
|
|
395
|
+
* @workflow ["system-configuration", "reference-lookup", "data-validation", "code-management"]
|
|
396
|
+
* @prerequisites ["Valid search query", "System configuration access"]
|
|
397
|
+
* @nextSteps ["Use codes for configuration", "api.p21Core.company for related entities"]
|
|
398
|
+
* @businessRules ["Search query required", "Code number filtering available", "Language-specific descriptions"]
|
|
399
|
+
* @functionalArea "system-configuration"
|
|
400
|
+
* @caching "Cache for 60 minutes, system codes rarely change"
|
|
401
|
+
* @performance "Full-text search on descriptions, indexed by code numbers"
|
|
402
|
+
*
|
|
403
|
+
* @param params Search parameters including required query
|
|
404
|
+
* @returns Promise<BaseResponse<P21Code[]>> Complete response with matching system codes
|
|
405
|
+
*
|
|
406
|
+
* @example
|
|
407
|
+
* ```typescript
|
|
408
|
+
* // Search for status codes
|
|
409
|
+
* const response = await client.codes.search({ q: 'status' });
|
|
410
|
+
* console.log(response.data); // P21Code[]
|
|
411
|
+
*
|
|
412
|
+
* // Get just the data
|
|
413
|
+
* const codes = await client.codes.searchData({ q: 'shipping' });
|
|
414
|
+
*
|
|
415
|
+
* // Filter by specific code numbers
|
|
416
|
+
* const filtered = await client.codes.search({
|
|
417
|
+
* q: 'status',
|
|
418
|
+
* codeNoList: '704,705,700'
|
|
419
|
+
* });
|
|
420
|
+
* ```
|
|
421
|
+
*/
|
|
422
|
+
search: (params?: {
|
|
423
|
+
q: string;
|
|
424
|
+
limit?: number | undefined;
|
|
425
|
+
offset?: number | undefined;
|
|
426
|
+
codeNoList?: string | undefined;
|
|
427
|
+
} | undefined) => Promise<BaseResponse<unknown[]>>;
|
|
428
|
+
searchData: (params: P21CodeListParams) => Promise<unknown[]>;
|
|
429
|
+
};
|
|
430
|
+
/**
|
|
431
|
+
* Location management operations for warehouse and distribution center configuration
|
|
432
|
+
* @fullPath api.p21Core.location
|
|
433
|
+
* @service p21-core
|
|
434
|
+
* @domain location-and-warehouse-management
|
|
435
|
+
* @discoverable true
|
|
436
|
+
*/
|
|
437
|
+
readonly location: {
|
|
438
|
+
/**
|
|
439
|
+
* List locations with filtering for warehouse and distribution management
|
|
440
|
+
*
|
|
441
|
+
* @fullPath api.p21Core.location.list
|
|
442
|
+
* @service p21-core
|
|
443
|
+
* @domain location-and-warehouse-management
|
|
444
|
+
* @dataMethod listData - returns only the location array without metadata
|
|
445
|
+
* @discoverable true
|
|
446
|
+
* @searchTerms ["locations", "warehouses", "distribution centers", "facilities", "branches", "sites"]
|
|
447
|
+
* @relatedEndpoints ["api.p21Core.location.get", "api.p21Core.company.list", "api.items.invLoc.list"]
|
|
448
|
+
* @commonPatterns ["List warehouse locations", "Distribution center management", "Facility directory", "Branch operations"]
|
|
449
|
+
* @workflow ["location-setup", "warehouse-management", "distribution-configuration", "facility-operations"]
|
|
450
|
+
* @prerequisites ["Valid authentication", "Location access permissions"]
|
|
451
|
+
* @nextSteps ["api.p21Core.location.get for details", "api.items.invLoc for inventory locations"]
|
|
452
|
+
* @businessRules ["Delete flag filters inactive locations", "Distribution center flag for DC identification", "Company scoped access"]
|
|
453
|
+
* @functionalArea "location-and-warehouse-management"
|
|
454
|
+
* @caching "Cache for 20 minutes, location data semi-static"
|
|
455
|
+
* @performance "Indexed by location ID and name, supports text search"
|
|
456
|
+
*
|
|
457
|
+
* @param params Optional filtering and pagination parameters
|
|
458
|
+
* @returns Promise<BaseResponse<Location[]>> Complete response with location array and metadata
|
|
459
|
+
*
|
|
460
|
+
* @example
|
|
461
|
+
* ```typescript
|
|
462
|
+
* // Get all active locations
|
|
463
|
+
* const response = await client.location.list({ deleteFlag: 'N' });
|
|
464
|
+
* console.log(response.data); // Location[]
|
|
465
|
+
*
|
|
466
|
+
* // Get just the data
|
|
467
|
+
* const locations = await client.location.listData();
|
|
468
|
+
*
|
|
469
|
+
* // Search for distribution centers
|
|
470
|
+
* const dcs = await client.location.list({ q: 'distribution' });
|
|
471
|
+
* ```
|
|
472
|
+
*/
|
|
473
|
+
list: (params?: {
|
|
474
|
+
limit?: number | undefined;
|
|
475
|
+
offset?: number | undefined;
|
|
476
|
+
q?: string | undefined;
|
|
477
|
+
orderBy?: string | undefined;
|
|
478
|
+
deleteFlag?: string | undefined;
|
|
479
|
+
} | undefined) => Promise<BaseResponse<unknown[]>>;
|
|
480
|
+
/**
|
|
481
|
+
* Get location details by ID for warehouse and facility information
|
|
482
|
+
*
|
|
483
|
+
* @fullPath api.p21Core.location.get
|
|
484
|
+
* @service p21-core
|
|
485
|
+
* @domain location-and-warehouse-management
|
|
486
|
+
* @dataMethod getData - returns only the location object without metadata
|
|
487
|
+
* @discoverable true
|
|
488
|
+
* @searchTerms ["location details", "warehouse info", "facility details", "distribution center", "branch info"]
|
|
489
|
+
* @relatedEndpoints ["api.p21Core.location.list", "api.p21Core.company.get", "api.items.invLoc.locationInventory"]
|
|
490
|
+
* @commonPatterns ["Get warehouse details", "View facility information", "Location configuration", "Distribution center setup"]
|
|
491
|
+
* @workflow ["location-details", "warehouse-configuration", "facility-management", "shipping-setup"]
|
|
492
|
+
* @prerequisites ["Valid location ID", "Location access permissions"]
|
|
493
|
+
* @nextSteps ["api.items.invLoc for inventory", "api.p21Core.company for company details"]
|
|
494
|
+
* @businessRules ["Location ID must exist", "Includes shipping integration settings", "Company association required"]
|
|
495
|
+
* @functionalArea "location-and-warehouse-management"
|
|
496
|
+
* @performance "Direct lookup by location ID, includes shipping configurations"
|
|
497
|
+
*
|
|
498
|
+
* @param params Location ID parameter
|
|
499
|
+
* @returns Promise<BaseResponse<Location>> Complete response with detailed location information
|
|
500
|
+
*/
|
|
501
|
+
get: (params: {
|
|
502
|
+
locationId: number;
|
|
503
|
+
}) => Promise<BaseResponse<unknown>>;
|
|
504
|
+
listData: (params?: LocationListParams) => Promise<unknown[]>;
|
|
505
|
+
getData: (params: {
|
|
506
|
+
locationId: number;
|
|
507
|
+
}) => Promise<unknown>;
|
|
508
|
+
};
|
|
509
|
+
/**
|
|
510
|
+
* Payment type management operations for payment processing configuration
|
|
511
|
+
* @fullPath api.p21Core.paymentTypes
|
|
512
|
+
* @service p21-core
|
|
513
|
+
* @domain payment-processing
|
|
514
|
+
* @discoverable true
|
|
515
|
+
*/
|
|
516
|
+
readonly paymentTypes: {
|
|
517
|
+
/**
|
|
518
|
+
* List payment types for payment processing and checkout configuration
|
|
519
|
+
*
|
|
520
|
+
* @fullPath api.p21Core.paymentTypes.list
|
|
521
|
+
* @service p21-core
|
|
522
|
+
* @domain payment-processing
|
|
523
|
+
* @dataMethod listData - returns only the payment types array without metadata
|
|
524
|
+
* @discoverable true
|
|
525
|
+
* @searchTerms ["payment types", "payment methods", "payment processing", "checkout options", "billing methods"]
|
|
526
|
+
* @relatedEndpoints ["api.payments.unified.paymentMethods", "api.commerce.checkout.paymentOptions", "api.orders.invoices.paymentHistory"]
|
|
527
|
+
* @commonPatterns ["List payment options", "Payment method configuration", "Checkout setup", "Billing configuration"]
|
|
528
|
+
* @workflow ["payment-setup", "checkout-configuration", "payment-processing", "billing-management"]
|
|
529
|
+
* @prerequisites ["Valid authentication", "Payment configuration access"]
|
|
530
|
+
* @nextSteps ["api.payments.unified for payment processing", "api.commerce.checkout for integration"]
|
|
531
|
+
* @businessRules ["Payment types define available options", "Configuration affects checkout flow", "Integration with payment processors"]
|
|
532
|
+
* @functionalArea "payment-processing"
|
|
533
|
+
* @caching "Cache for 45 minutes, payment types change infrequently"
|
|
534
|
+
* @performance "Simple list operation, minimal data volume"
|
|
535
|
+
*
|
|
536
|
+
* @param params Optional pagination parameters
|
|
537
|
+
* @returns Promise<BaseResponse<PaymentType[]>> Complete response with payment types array
|
|
538
|
+
*
|
|
539
|
+
* @example
|
|
540
|
+
* ```typescript
|
|
541
|
+
* // Get all payment types
|
|
542
|
+
* const response = await client.paymentTypes.list();
|
|
543
|
+
* console.log(response.data); // PaymentType[]
|
|
544
|
+
*
|
|
545
|
+
* // Get just the data
|
|
546
|
+
* const paymentTypes = await client.paymentTypes.listData();
|
|
547
|
+
*
|
|
548
|
+
* // Paginated results
|
|
549
|
+
* const paged = await client.paymentTypes.list({ limit: 20, offset: 0 });
|
|
550
|
+
* ```
|
|
551
|
+
*/
|
|
552
|
+
list: (params?: {
|
|
553
|
+
limit?: number | undefined;
|
|
554
|
+
offset?: number | undefined;
|
|
555
|
+
} | undefined) => Promise<BaseResponse<unknown[]>>;
|
|
556
|
+
listData: (params?: PaymentTypeListParams) => Promise<unknown[]>;
|
|
557
|
+
};
|
|
558
|
+
/**
|
|
559
|
+
* Health check operations for service monitoring and system status verification
|
|
560
|
+
* @fullPath api.p21Core.health
|
|
561
|
+
* @service p21-core
|
|
562
|
+
* @domain system-monitoring
|
|
563
|
+
* @discoverable true
|
|
564
|
+
*/
|
|
565
|
+
readonly health: {
|
|
566
|
+
/**
|
|
567
|
+
* Perform health check to verify P21 Core service status and connectivity
|
|
568
|
+
*
|
|
569
|
+
* @fullPath api.p21Core.health.check
|
|
570
|
+
* @service p21-core
|
|
571
|
+
* @domain system-monitoring
|
|
572
|
+
* @dataMethod checkData - returns only the health status without metadata
|
|
573
|
+
* @discoverable true
|
|
574
|
+
* @searchTerms ["health check", "service status", "system monitor", "service availability", "connectivity test"]
|
|
575
|
+
* @relatedEndpoints ["api.p21Core.ping", "system monitoring endpoints"]
|
|
576
|
+
* @commonPatterns ["Check service health", "Monitor system status", "Verify connectivity", "Service diagnostics"]
|
|
577
|
+
* @workflow ["system-monitoring", "health-verification", "service-diagnostics"]
|
|
578
|
+
* @prerequisites ["System access", "Monitoring permissions"]
|
|
579
|
+
* @nextSteps ["Service remediation if unhealthy", "Integration health checks"]
|
|
580
|
+
* @businessRules ["Returns site configuration", "Includes system hash for verification", "No authentication required"]
|
|
581
|
+
* @functionalArea "system-monitoring"
|
|
582
|
+
* @performance "Lightweight check, immediate response"
|
|
583
|
+
*
|
|
584
|
+
* @returns Promise<BaseResponse<HealthCheckResponse>> Service health status and configuration
|
|
585
|
+
*/
|
|
586
|
+
check: () => Promise<{
|
|
587
|
+
params: Record<string, unknown> | unknown[];
|
|
588
|
+
data: {
|
|
589
|
+
siteHash: string;
|
|
590
|
+
siteId: string;
|
|
591
|
+
};
|
|
592
|
+
options: Record<string, unknown> | unknown[];
|
|
593
|
+
status: number;
|
|
594
|
+
message: string;
|
|
595
|
+
count: number;
|
|
596
|
+
total: number;
|
|
597
|
+
totalResults: number;
|
|
598
|
+
}>;
|
|
599
|
+
/**
|
|
600
|
+
* Ping endpoint for basic connectivity testing and service availability
|
|
601
|
+
*
|
|
602
|
+
* @fullPath api.p21Core.health.ping
|
|
603
|
+
* @service p21-core
|
|
604
|
+
* @domain system-monitoring
|
|
605
|
+
* @dataMethod pingData - returns only the ping response without metadata
|
|
606
|
+
* @discoverable true
|
|
607
|
+
* @searchTerms ["ping", "connectivity", "service alive", "basic check", "availability test"]
|
|
608
|
+
* @relatedEndpoints ["api.p21Core.health.check"]
|
|
609
|
+
* @commonPatterns ["Test connectivity", "Basic availability check", "Service ping", "Network test"]
|
|
610
|
+
* @workflow ["connectivity-testing", "basic-monitoring", "network-verification"]
|
|
611
|
+
* @prerequisites ["Network access"]
|
|
612
|
+
* @nextSteps ["Full health check if ping succeeds"]
|
|
613
|
+
* @businessRules ["Minimal response for speed", "No authentication required", "Returns simple pong response"]
|
|
614
|
+
* @functionalArea "system-monitoring"
|
|
615
|
+
* @performance "Fastest possible response, minimal processing"
|
|
616
|
+
*
|
|
617
|
+
* @returns Promise<BaseResponse<string>> Simple ping response confirmation
|
|
618
|
+
*/
|
|
619
|
+
ping: () => Promise<BaseResponse<unknown>>;
|
|
620
|
+
checkData: () => Promise<{
|
|
621
|
+
siteHash: string;
|
|
622
|
+
siteId: string;
|
|
623
|
+
}>;
|
|
624
|
+
pingData: () => Promise<unknown>;
|
|
625
|
+
};
|
|
626
|
+
}
|
|
627
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/p21-core/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,KAAK,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAU9E,OAAO,EAiBL,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC3B,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;IAElD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAOjB;IAGX,OAAO,KAAK,UAAU,GAErB;IAED;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAAyC;IAMhF;;;;;;OAMG;IACH,SAAgB,OAAO;QACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;;;;;;;;;QAGH;;;;;;;;;;;;;;;;;;;;WAoBG;sBACiB;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE;QAYlC;;;;;;;;;;;;;;;;;;WAkBG;kCAC6B,qBAAqB;QAarD;;;;;;;;;;;;;;;;;WAiBG;6BACwB;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE;QAYzC;;;;;;;;;;;;;;;;;WAiBG;yBACoB,mBAAmB;QAa1C;;;;;;;;;;;;;;;;;WAiBG;;4BAUuB,iBAAiB;0BAKnB;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE;sCAKF,qBAAqB;iCAK1B;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE;6BAKlB,mBAAmB;;MAS9C;IAEF;;;;;;OAMG;IACH,SAAgB,UAAU;QACxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;;;;;;;;;QAOH;;;;;;;;;;;;;;;;;;;;WAoBG;sBACiB;YAAE,aAAa,EAAE,MAAM,CAAA;SAAE;4BAanB,oBAAoB;0BAKtB;YAAE,aAAa,EAAE,MAAM,CAAA;SAAE;MAIjD;IAEF;;;;;;OAMG;IACH,SAAgB,OAAO;QACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqCG;;;;;;;;QAGH;;;;;;;;;;;;;;;;;;;;WAoBG;sBACiB,mBAAmB;4BAcb,iBAAiB;0BAKnB,mBAAmB;MAI3C;IAEF;;;;;;OAMG;IACH,SAAgB,KAAK;QACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqCG;;;;;;;6BAIwB,iBAAiB;MAI5C;IAEF;;;;;;OAMG;IACH,SAAgB,QAAQ;QACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;;;;;;;;QAGH;;;;;;;;;;;;;;;;;;;;WAoBG;sBACiB;YAAE,UAAU,EAAE,MAAM,CAAA;SAAE;4BAahB,kBAAkB;0BAKpB;YAAE,UAAU,EAAE,MAAM,CAAA;SAAE;MAI9C;IAEF;;;;;;OAMG;IACH,SAAgB,YAAY;QAC1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;;;;;4BAQuB,qBAAqB;MAI/C;IAEF;;;;;;OAMG;IACH,SAAgB,MAAM;QACpB;;;;;;;;;;;;;;;;;;;WAmBG;;;;;;;;;;;;;;QASH;;;;;;;;;;;;;;;;;;;WAmBG;;;;;;;MAmBH;CACH"}
|