@voltade/envoy-sdk 1.0.5 → 1.1.1
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/client.d.ts +5 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +2 -1
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/resources/index.d.ts +1 -0
- package/dist/resources/index.d.ts.map +1 -1
- package/dist/resources/index.js +1 -0
- package/dist/resources/index.js.map +1 -1
- package/dist/resources/orders/index.d.ts +83 -0
- package/dist/resources/orders/index.d.ts.map +1 -0
- package/dist/resources/orders/index.js +110 -0
- package/dist/resources/orders/index.js.map +1 -0
- package/dist/resources/orders/types.d.ts +474 -0
- package/dist/resources/orders/types.d.ts.map +1 -0
- package/dist/resources/orders/types.js +75 -0
- package/dist/resources/orders/types.js.map +1 -0
- package/dist/test.d.ts +6 -0
- package/dist/test.d.ts.map +1 -0
- package/dist/test.js +115 -0
- package/dist/test.js.map +1 -0
- package/package.json +3 -1
package/dist/client.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpClient } from './http-client.js';
|
|
2
|
-
import { Conversations, Inboxes } from './resources/index.js';
|
|
2
|
+
import { Conversations, Inboxes, Orders } from './resources/index.js';
|
|
3
3
|
/**
|
|
4
4
|
* Configuration options for EnvoyClient
|
|
5
5
|
*/
|
|
@@ -47,6 +47,10 @@ export declare class EnvoyClient {
|
|
|
47
47
|
* Inboxes resource for managing inboxes and searching knowledge base
|
|
48
48
|
*/
|
|
49
49
|
readonly inboxes: Inboxes;
|
|
50
|
+
/**
|
|
51
|
+
* Orders resource for managing orders
|
|
52
|
+
*/
|
|
53
|
+
readonly orders: Orders;
|
|
50
54
|
constructor(config: EnvoyClientConfig);
|
|
51
55
|
/**
|
|
52
56
|
* Get the HTTP client instance (for advanced use cases)
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAyB,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAyB,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IAExC;;OAEG;IACH,SAAgB,aAAa,EAAE,aAAa,CAAC;IAE7C;;OAEG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,SAAgB,MAAM,EAAE,MAAM,CAAC;gBAEnB,MAAM,EAAE,iBAAiB;IAarC;;;OAGG;IACH,aAAa,IAAI,UAAU;CAG5B"}
|
package/dist/client.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpClient } from './http-client.js';
|
|
2
|
-
import { Conversations, Inboxes } from './resources/index.js';
|
|
2
|
+
import { Conversations, Inboxes, Orders } from './resources/index.js';
|
|
3
3
|
/**
|
|
4
4
|
* Envoy API Client
|
|
5
5
|
* A comprehensive SDK for interacting with the Envoy API
|
|
@@ -37,6 +37,7 @@ export class EnvoyClient {
|
|
|
37
37
|
// Initialize resources
|
|
38
38
|
this.conversations = new Conversations(this.httpClient);
|
|
39
39
|
this.inboxes = new Inboxes(this.httpClient);
|
|
40
|
+
this.orders = new Orders(this.httpClient);
|
|
40
41
|
}
|
|
41
42
|
/**
|
|
42
43
|
* Get the HTTP client instance (for advanced use cases)
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAyB,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAyB,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAYtE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,WAAW;IAkBtB,YAAY,MAAyB;QACnC,MAAM,UAAU,GAAqB;YACnC,GAAG,MAAM;SACV,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;QAE7C,uBAAuB;QACvB,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF"}
|
package/dist/index.d.ts
CHANGED
|
@@ -23,10 +23,10 @@
|
|
|
23
23
|
* ```
|
|
24
24
|
*/
|
|
25
25
|
export { EnvoyClient, type EnvoyClientConfig } from "./client.js";
|
|
26
|
-
export type { Agent, Article, Assignee, Contact, ContactInbox, Conversation, ConversationMeta, ConversationStatus, ContentType, CreateMessageParams, EscalationResponse, EscalationType, Message, MessageType, MessagesResponse, MessagesResponseMeta, Priority, SearchParams, SearchResponse, Team, } from "./resources/index.js";
|
|
26
|
+
export type { Agent, Article, Assignee, Contact, ContactInbox, Conversation, ConversationMeta, ConversationStatus, ContentType, CreateMessageParams, EscalationResponse, EscalationType, ListOrdersParams, ListOrdersResponse, Message, MessageType, MessagesResponse, MessagesResponseMeta, Order, OrdersMeta, Priority, UpsertOrderParams, UpsertOrderRequest, UpsertOrderResponse, UpsertOrderResponsePayload, SearchParams, SearchResponse, Team, } from "./resources/index.js";
|
|
27
27
|
export { webhookEvent } from "./resources/webhooks/index.js";
|
|
28
|
-
export { Conversations, Inboxes } from
|
|
29
|
-
export { AgentSchema, ArticleSchema, AssigneeSchema, ContactInboxSchema, ContactSchema, ConversationMetaSchema, ConversationSchema, ConversationStatusSchema, ContentTypeSchema, CreateMessageParamsSchema, EscalationResponseSchema, EscalationTypeSchema, MessageSchema, MessagesResponseMetaSchema, MessagesResponseSchema, MessageTypeSchema, PrioritySchema, SearchParamsSchema, SearchResponseSchema, TeamSchema, } from "./resources/index.js";
|
|
28
|
+
export { Conversations, Inboxes, Orders } from './resources/index.js';
|
|
29
|
+
export { AgentSchema, ArticleSchema, AssigneeSchema, ContactInboxSchema, ContactSchema, ConversationMetaSchema, ConversationSchema, ConversationStatusSchema, ContentTypeSchema, CreateMessageParamsSchema, EscalationResponseSchema, EscalationTypeSchema, ListOrdersParamsSchema, ListOrdersResponseSchema, MessageSchema, MessagesResponseMetaSchema, MessagesResponseSchema, MessageTypeSchema, OrdersMetaSchema, OrderSchema, PrioritySchema, UpsertOrderParamsSchema, UpsertOrderRequestSchema, UpsertOrderResponsePayloadSchema, UpsertOrderResponseSchema, SearchParamsSchema, SearchResponseSchema, TeamSchema, } from "./resources/index.js";
|
|
30
30
|
export { HttpClient } from "./http-client.js";
|
|
31
31
|
export { AuthenticationError, BadRequestError, EnvoyError, NetworkError, NotFoundError, RateLimitError, ServerError, ValidationError, } from "./errors.js";
|
|
32
32
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAGH,OAAO,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGlE,YAAY,EACV,KAAK,EACL,OAAO,EACP,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,OAAO,EACP,WAAW,EACX,gBAAgB,EAChB,oBAAoB,EACpB,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,IAAI,GACL,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAGH,OAAO,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGlE,YAAY,EACV,KAAK,EACL,OAAO,EACP,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,WAAW,EACX,gBAAgB,EAChB,oBAAoB,EACpB,KAAK,EACL,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,0BAA0B,EAC1B,YAAY,EACZ,cAAc,EACd,IAAI,GACL,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAGtE,OAAO,EACL,WAAW,EACX,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,aAAa,EACb,sBAAsB,EACtB,kBAAkB,EAClB,wBAAwB,EACxB,iBAAiB,EACjB,yBAAyB,EACzB,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,aAAa,EACb,0BAA0B,EAC1B,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACX,cAAc,EACd,uBAAuB,EACvB,wBAAwB,EACxB,gCAAgC,EAChC,yBAAyB,EACzB,kBAAkB,EAClB,oBAAoB,EACpB,UAAU,GACX,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,UAAU,EACV,YAAY,EACZ,aAAa,EACb,cAAc,EACd,WAAW,EACX,eAAe,GAChB,MAAM,aAAa,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
// Main client export
|
|
26
26
|
export { EnvoyClient } from "./client.js";
|
|
27
27
|
export { webhookEvent } from "./resources/webhooks/index.js";
|
|
28
|
-
export { Conversations, Inboxes } from
|
|
28
|
+
export { Conversations, Inboxes, Orders } from './resources/index.js';
|
|
29
29
|
// Zod schema exports
|
|
30
|
-
export { AgentSchema, ArticleSchema, AssigneeSchema, ContactInboxSchema, ContactSchema, ConversationMetaSchema, ConversationSchema, ConversationStatusSchema, ContentTypeSchema, CreateMessageParamsSchema, EscalationResponseSchema, EscalationTypeSchema, MessageSchema, MessagesResponseMetaSchema, MessagesResponseSchema, MessageTypeSchema, PrioritySchema, SearchParamsSchema, SearchResponseSchema, TeamSchema, } from "./resources/index.js";
|
|
30
|
+
export { AgentSchema, ArticleSchema, AssigneeSchema, ContactInboxSchema, ContactSchema, ConversationMetaSchema, ConversationSchema, ConversationStatusSchema, ContentTypeSchema, CreateMessageParamsSchema, EscalationResponseSchema, EscalationTypeSchema, ListOrdersParamsSchema, ListOrdersResponseSchema, MessageSchema, MessagesResponseMetaSchema, MessagesResponseSchema, MessageTypeSchema, OrdersMetaSchema, OrderSchema, PrioritySchema, UpsertOrderParamsSchema, UpsertOrderRequestSchema, UpsertOrderResponsePayloadSchema, UpsertOrderResponseSchema, SearchParamsSchema, SearchResponseSchema, TeamSchema, } from "./resources/index.js";
|
|
31
31
|
// Utility exports
|
|
32
32
|
export { HttpClient } from "./http-client.js";
|
|
33
33
|
// Error exports
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,qBAAqB;AACrB,OAAO,EAAE,WAAW,EAA0B,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,qBAAqB;AACrB,OAAO,EAAE,WAAW,EAA0B,MAAM,aAAa,CAAC;AAiClE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAEtE,qBAAqB;AACrB,OAAO,EACL,WAAW,EACX,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,aAAa,EACb,sBAAsB,EACtB,kBAAkB,EAClB,wBAAwB,EACxB,iBAAiB,EACjB,yBAAyB,EACzB,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,aAAa,EACb,0BAA0B,EAC1B,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACX,cAAc,EACd,uBAAuB,EACvB,wBAAwB,EACxB,gCAAgC,EAChC,yBAAyB,EACzB,kBAAkB,EAClB,oBAAoB,EACpB,UAAU,GACX,MAAM,sBAAsB,CAAC;AAE9B,kBAAkB;AAClB,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,gBAAgB;AAChB,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,UAAU,EACV,YAAY,EACZ,aAAa,EACb,cAAc,EACd,WAAW,EACX,eAAe,GAChB,MAAM,aAAa,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../resources/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../resources/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC"}
|
package/dist/resources/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../resources/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../resources/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC"}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Orders resource module
|
|
3
|
+
* Provides functionality for managing orders in Envoy
|
|
4
|
+
*/
|
|
5
|
+
import type { HttpClient } from '../../http-client.js';
|
|
6
|
+
import type { ListOrdersParams, ListOrdersResponse, UpsertOrderParams, UpsertOrderResponse } from './types.js';
|
|
7
|
+
/**
|
|
8
|
+
* Base resource class that all resource classes extend from
|
|
9
|
+
*/
|
|
10
|
+
declare abstract class BaseResource {
|
|
11
|
+
protected readonly client: HttpClient;
|
|
12
|
+
constructor(client: HttpClient);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Orders resource class for managing order-related operations
|
|
16
|
+
*/
|
|
17
|
+
export declare class Orders extends BaseResource {
|
|
18
|
+
/**
|
|
19
|
+
* List all orders with pagination and filtering
|
|
20
|
+
* @param params - Query parameters for filtering and pagination
|
|
21
|
+
* @returns Paginated list of orders with metadata
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```typescript
|
|
25
|
+
* // List orders with default pagination
|
|
26
|
+
* const response = await client.orders.list();
|
|
27
|
+
* console.log(response.data); // Array of orders
|
|
28
|
+
* console.log(response.meta); // Pagination metadata
|
|
29
|
+
*
|
|
30
|
+
* // List orders with custom pagination
|
|
31
|
+
* const response = await client.orders.list({
|
|
32
|
+
* page: 2,
|
|
33
|
+
* per_page: 50
|
|
34
|
+
* });
|
|
35
|
+
*
|
|
36
|
+
* // List orders with date filtering
|
|
37
|
+
* const response = await client.orders.list({
|
|
38
|
+
* since: '2024-01-01',
|
|
39
|
+
* until: '2024-12-31',
|
|
40
|
+
* sort: '-created_at'
|
|
41
|
+
* });
|
|
42
|
+
*
|
|
43
|
+
* // List orders with advanced filtering
|
|
44
|
+
* const response = await client.orders.list({
|
|
45
|
+
* payload: [
|
|
46
|
+
* { field: 'financial_status', operator: 'eq', value: 'paid' }
|
|
47
|
+
* ]
|
|
48
|
+
* });
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
list(params?: ListOrdersParams): Promise<ListOrdersResponse>;
|
|
52
|
+
/**
|
|
53
|
+
* Create or update an order based on source and source_id
|
|
54
|
+
* If an order with the same source and source_id exists, it will be updated.
|
|
55
|
+
* Otherwise, a new order will be created.
|
|
56
|
+
*
|
|
57
|
+
* @param params - Order data with required source and source_id
|
|
58
|
+
* @returns The created or updated order
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* ```typescript
|
|
62
|
+
* // Create or update an order
|
|
63
|
+
* const result = await client.orders.upsert({
|
|
64
|
+
* name: 'ORD-12345',
|
|
65
|
+
* contact_id: 101,
|
|
66
|
+
* total_amount: 150,
|
|
67
|
+
* currency_code: 'USD',
|
|
68
|
+
* financial_status: 'paid',
|
|
69
|
+
* fulfillment_status: 'fulfilled',
|
|
70
|
+
* source: 'shopify',
|
|
71
|
+
* source_id: '789456123',
|
|
72
|
+
* order_url: 'https://mystore.myshopify.com/admin/orders/789456123',
|
|
73
|
+
* notes: 'Customer requested gift wrapping',
|
|
74
|
+
* metadata: {}
|
|
75
|
+
* });
|
|
76
|
+
* console.log(result.payload); // The created/updated order
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
upsert(params: UpsertOrderParams): Promise<UpsertOrderResponse>;
|
|
80
|
+
}
|
|
81
|
+
export type { ListOrdersParams, ListOrdersResponse, Order, OrdersMeta, UpsertOrderParams, UpsertOrderRequest, UpsertOrderResponse, UpsertOrderResponsePayload, } from './types.js';
|
|
82
|
+
export { ListOrdersParamsSchema, ListOrdersResponseSchema, OrdersMetaSchema, OrderSchema, UpsertOrderParamsSchema, UpsertOrderRequestSchema, UpsertOrderResponsePayloadSchema, UpsertOrderResponseSchema, } from './types.js';
|
|
83
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../resources/orders/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EACV,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,uBAAe,YAAY;IACb,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU;gBAAlB,MAAM,EAAE,UAAU;CAClD;AAED;;GAEG;AACH,qBAAa,MAAO,SAAQ,YAAY;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA4BlE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAKtE;AAGD,YAAY,EACV,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,EACL,UAAU,EACV,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,0BAA0B,GAC3B,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,EAChB,WAAW,EACX,uBAAuB,EACvB,wBAAwB,EACxB,gCAAgC,EAChC,yBAAyB,GAC1B,MAAM,YAAY,CAAC"}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Orders resource module
|
|
3
|
+
* Provides functionality for managing orders in Envoy
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* Base resource class that all resource classes extend from
|
|
7
|
+
*/
|
|
8
|
+
class BaseResource {
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.client = client;
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Orders resource class for managing order-related operations
|
|
15
|
+
*/
|
|
16
|
+
export class Orders extends BaseResource {
|
|
17
|
+
/**
|
|
18
|
+
* List all orders with pagination and filtering
|
|
19
|
+
* @param params - Query parameters for filtering and pagination
|
|
20
|
+
* @returns Paginated list of orders with metadata
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```typescript
|
|
24
|
+
* // List orders with default pagination
|
|
25
|
+
* const response = await client.orders.list();
|
|
26
|
+
* console.log(response.data); // Array of orders
|
|
27
|
+
* console.log(response.meta); // Pagination metadata
|
|
28
|
+
*
|
|
29
|
+
* // List orders with custom pagination
|
|
30
|
+
* const response = await client.orders.list({
|
|
31
|
+
* page: 2,
|
|
32
|
+
* per_page: 50
|
|
33
|
+
* });
|
|
34
|
+
*
|
|
35
|
+
* // List orders with date filtering
|
|
36
|
+
* const response = await client.orders.list({
|
|
37
|
+
* since: '2024-01-01',
|
|
38
|
+
* until: '2024-12-31',
|
|
39
|
+
* sort: '-created_at'
|
|
40
|
+
* });
|
|
41
|
+
*
|
|
42
|
+
* // List orders with advanced filtering
|
|
43
|
+
* const response = await client.orders.list({
|
|
44
|
+
* payload: [
|
|
45
|
+
* { field: 'financial_status', operator: 'eq', value: 'paid' }
|
|
46
|
+
* ]
|
|
47
|
+
* });
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
async list(params) {
|
|
51
|
+
const queryParams = {};
|
|
52
|
+
if (params?.page !== undefined) {
|
|
53
|
+
queryParams.page = params.page;
|
|
54
|
+
}
|
|
55
|
+
if (params?.per_page !== undefined) {
|
|
56
|
+
queryParams.per_page = params.per_page;
|
|
57
|
+
}
|
|
58
|
+
if (params?.since) {
|
|
59
|
+
queryParams.since = params.since;
|
|
60
|
+
}
|
|
61
|
+
if (params?.until) {
|
|
62
|
+
queryParams.until = params.until;
|
|
63
|
+
}
|
|
64
|
+
if (params?.sort) {
|
|
65
|
+
queryParams.sort = params.sort;
|
|
66
|
+
}
|
|
67
|
+
if (params?.payload) {
|
|
68
|
+
// Convert payload array to JSON string for query parameter
|
|
69
|
+
queryParams.payload = JSON.stringify(params.payload);
|
|
70
|
+
}
|
|
71
|
+
return await this.client.get('/orders', {
|
|
72
|
+
params: queryParams,
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Create or update an order based on source and source_id
|
|
77
|
+
* If an order with the same source and source_id exists, it will be updated.
|
|
78
|
+
* Otherwise, a new order will be created.
|
|
79
|
+
*
|
|
80
|
+
* @param params - Order data with required source and source_id
|
|
81
|
+
* @returns The created or updated order
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```typescript
|
|
85
|
+
* // Create or update an order
|
|
86
|
+
* const result = await client.orders.upsert({
|
|
87
|
+
* name: 'ORD-12345',
|
|
88
|
+
* contact_id: 101,
|
|
89
|
+
* total_amount: 150,
|
|
90
|
+
* currency_code: 'USD',
|
|
91
|
+
* financial_status: 'paid',
|
|
92
|
+
* fulfillment_status: 'fulfilled',
|
|
93
|
+
* source: 'shopify',
|
|
94
|
+
* source_id: '789456123',
|
|
95
|
+
* order_url: 'https://mystore.myshopify.com/admin/orders/789456123',
|
|
96
|
+
* notes: 'Customer requested gift wrapping',
|
|
97
|
+
* metadata: {}
|
|
98
|
+
* });
|
|
99
|
+
* console.log(result.payload); // The created/updated order
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
async upsert(params) {
|
|
103
|
+
return await this.client.post('/orders/upsert', {
|
|
104
|
+
order: params,
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
// Re-export Zod schemas
|
|
109
|
+
export { ListOrdersParamsSchema, ListOrdersResponseSchema, OrdersMetaSchema, OrderSchema, UpsertOrderParamsSchema, UpsertOrderRequestSchema, UpsertOrderResponsePayloadSchema, UpsertOrderResponseSchema, } from './types.js';
|
|
110
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../resources/orders/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;GAEG;AACH,MAAe,YAAY;IACzB,YAA+B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,YAAY;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,IAAI,CAAC,MAAyB;QAClC,MAAM,WAAW,GAAoC,EAAE,CAAC;QAExD,IAAI,MAAM,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,WAAW,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACjC,CAAC;QACD,IAAI,MAAM,EAAE,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,WAAW,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACzC,CAAC;QACD,IAAI,MAAM,EAAE,KAAK,EAAE,CAAC;YAClB,WAAW,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QACnC,CAAC;QACD,IAAI,MAAM,EAAE,KAAK,EAAE,CAAC;YAClB,WAAW,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QACnC,CAAC;QACD,IAAI,MAAM,EAAE,IAAI,EAAE,CAAC;YACjB,WAAW,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACjC,CAAC;QACD,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;YACpB,2DAA2D;YAC3D,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACvD,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAqB,SAAS,EAAE;YAC1D,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,MAAM,CAAC,MAAyB;QACpC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAsB,gBAAgB,EAAE;YACnE,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,CAAC;CACF;AAcD,wBAAwB;AACxB,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,EAChB,WAAW,EACX,uBAAuB,EACvB,wBAAwB,EACxB,gCAAgC,EAChC,yBAAyB,GAC1B,MAAM,YAAY,CAAC"}
|
|
@@ -0,0 +1,474 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
/**
|
|
3
|
+
* Zod Schemas for Orders
|
|
4
|
+
*/
|
|
5
|
+
export declare const OrderSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
6
|
+
export declare const OrderMetadataSchema: z.ZodObject<{
|
|
7
|
+
part_number: z.ZodOptional<z.ZodString>;
|
|
8
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
9
|
+
description: z.ZodOptional<z.ZodString>;
|
|
10
|
+
line_total: z.ZodOptional<z.ZodNumber>;
|
|
11
|
+
}, "strip", z.ZodTypeAny, {
|
|
12
|
+
part_number?: string | undefined;
|
|
13
|
+
quantity?: number | undefined;
|
|
14
|
+
description?: string | undefined;
|
|
15
|
+
line_total?: number | undefined;
|
|
16
|
+
}, {
|
|
17
|
+
part_number?: string | undefined;
|
|
18
|
+
quantity?: number | undefined;
|
|
19
|
+
description?: string | undefined;
|
|
20
|
+
line_total?: number | undefined;
|
|
21
|
+
}>;
|
|
22
|
+
export declare const UpsertOrderParamsSchema: z.ZodObject<{
|
|
23
|
+
name: z.ZodOptional<z.ZodString>;
|
|
24
|
+
contact_id: z.ZodOptional<z.ZodNumber>;
|
|
25
|
+
total_amount: z.ZodOptional<z.ZodNumber>;
|
|
26
|
+
currency_code: z.ZodOptional<z.ZodString>;
|
|
27
|
+
financial_status: z.ZodOptional<z.ZodString>;
|
|
28
|
+
fulfillment_status: z.ZodOptional<z.ZodString>;
|
|
29
|
+
source: z.ZodString;
|
|
30
|
+
source_id: z.ZodString;
|
|
31
|
+
order_url: z.ZodOptional<z.ZodString>;
|
|
32
|
+
notes: z.ZodOptional<z.ZodString>;
|
|
33
|
+
metadata: z.ZodOptional<z.ZodObject<{
|
|
34
|
+
part_number: z.ZodOptional<z.ZodString>;
|
|
35
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
36
|
+
description: z.ZodOptional<z.ZodString>;
|
|
37
|
+
line_total: z.ZodOptional<z.ZodNumber>;
|
|
38
|
+
}, "strip", z.ZodTypeAny, {
|
|
39
|
+
part_number?: string | undefined;
|
|
40
|
+
quantity?: number | undefined;
|
|
41
|
+
description?: string | undefined;
|
|
42
|
+
line_total?: number | undefined;
|
|
43
|
+
}, {
|
|
44
|
+
part_number?: string | undefined;
|
|
45
|
+
quantity?: number | undefined;
|
|
46
|
+
description?: string | undefined;
|
|
47
|
+
line_total?: number | undefined;
|
|
48
|
+
}>>;
|
|
49
|
+
}, "strip", z.ZodTypeAny, {
|
|
50
|
+
source_id: string;
|
|
51
|
+
source: string;
|
|
52
|
+
name?: string | undefined;
|
|
53
|
+
contact_id?: number | undefined;
|
|
54
|
+
total_amount?: number | undefined;
|
|
55
|
+
currency_code?: string | undefined;
|
|
56
|
+
financial_status?: string | undefined;
|
|
57
|
+
fulfillment_status?: string | undefined;
|
|
58
|
+
order_url?: string | undefined;
|
|
59
|
+
notes?: string | undefined;
|
|
60
|
+
metadata?: {
|
|
61
|
+
part_number?: string | undefined;
|
|
62
|
+
quantity?: number | undefined;
|
|
63
|
+
description?: string | undefined;
|
|
64
|
+
line_total?: number | undefined;
|
|
65
|
+
} | undefined;
|
|
66
|
+
}, {
|
|
67
|
+
source_id: string;
|
|
68
|
+
source: string;
|
|
69
|
+
name?: string | undefined;
|
|
70
|
+
contact_id?: number | undefined;
|
|
71
|
+
total_amount?: number | undefined;
|
|
72
|
+
currency_code?: string | undefined;
|
|
73
|
+
financial_status?: string | undefined;
|
|
74
|
+
fulfillment_status?: string | undefined;
|
|
75
|
+
order_url?: string | undefined;
|
|
76
|
+
notes?: string | undefined;
|
|
77
|
+
metadata?: {
|
|
78
|
+
part_number?: string | undefined;
|
|
79
|
+
quantity?: number | undefined;
|
|
80
|
+
description?: string | undefined;
|
|
81
|
+
line_total?: number | undefined;
|
|
82
|
+
} | undefined;
|
|
83
|
+
}>;
|
|
84
|
+
export declare const UpsertOrderRequestSchema: z.ZodObject<{
|
|
85
|
+
order: z.ZodObject<{
|
|
86
|
+
name: z.ZodOptional<z.ZodString>;
|
|
87
|
+
contact_id: z.ZodOptional<z.ZodNumber>;
|
|
88
|
+
total_amount: z.ZodOptional<z.ZodNumber>;
|
|
89
|
+
currency_code: z.ZodOptional<z.ZodString>;
|
|
90
|
+
financial_status: z.ZodOptional<z.ZodString>;
|
|
91
|
+
fulfillment_status: z.ZodOptional<z.ZodString>;
|
|
92
|
+
source: z.ZodString;
|
|
93
|
+
source_id: z.ZodString;
|
|
94
|
+
order_url: z.ZodOptional<z.ZodString>;
|
|
95
|
+
notes: z.ZodOptional<z.ZodString>;
|
|
96
|
+
metadata: z.ZodOptional<z.ZodObject<{
|
|
97
|
+
part_number: z.ZodOptional<z.ZodString>;
|
|
98
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
99
|
+
description: z.ZodOptional<z.ZodString>;
|
|
100
|
+
line_total: z.ZodOptional<z.ZodNumber>;
|
|
101
|
+
}, "strip", z.ZodTypeAny, {
|
|
102
|
+
part_number?: string | undefined;
|
|
103
|
+
quantity?: number | undefined;
|
|
104
|
+
description?: string | undefined;
|
|
105
|
+
line_total?: number | undefined;
|
|
106
|
+
}, {
|
|
107
|
+
part_number?: string | undefined;
|
|
108
|
+
quantity?: number | undefined;
|
|
109
|
+
description?: string | undefined;
|
|
110
|
+
line_total?: number | undefined;
|
|
111
|
+
}>>;
|
|
112
|
+
}, "strip", z.ZodTypeAny, {
|
|
113
|
+
source_id: string;
|
|
114
|
+
source: string;
|
|
115
|
+
name?: string | undefined;
|
|
116
|
+
contact_id?: number | undefined;
|
|
117
|
+
total_amount?: number | undefined;
|
|
118
|
+
currency_code?: string | undefined;
|
|
119
|
+
financial_status?: string | undefined;
|
|
120
|
+
fulfillment_status?: string | undefined;
|
|
121
|
+
order_url?: string | undefined;
|
|
122
|
+
notes?: string | undefined;
|
|
123
|
+
metadata?: {
|
|
124
|
+
part_number?: string | undefined;
|
|
125
|
+
quantity?: number | undefined;
|
|
126
|
+
description?: string | undefined;
|
|
127
|
+
line_total?: number | undefined;
|
|
128
|
+
} | undefined;
|
|
129
|
+
}, {
|
|
130
|
+
source_id: string;
|
|
131
|
+
source: string;
|
|
132
|
+
name?: string | undefined;
|
|
133
|
+
contact_id?: number | undefined;
|
|
134
|
+
total_amount?: number | undefined;
|
|
135
|
+
currency_code?: string | undefined;
|
|
136
|
+
financial_status?: string | undefined;
|
|
137
|
+
fulfillment_status?: string | undefined;
|
|
138
|
+
order_url?: string | undefined;
|
|
139
|
+
notes?: string | undefined;
|
|
140
|
+
metadata?: {
|
|
141
|
+
part_number?: string | undefined;
|
|
142
|
+
quantity?: number | undefined;
|
|
143
|
+
description?: string | undefined;
|
|
144
|
+
line_total?: number | undefined;
|
|
145
|
+
} | undefined;
|
|
146
|
+
}>;
|
|
147
|
+
}, "strip", z.ZodTypeAny, {
|
|
148
|
+
order: {
|
|
149
|
+
source_id: string;
|
|
150
|
+
source: string;
|
|
151
|
+
name?: string | undefined;
|
|
152
|
+
contact_id?: number | undefined;
|
|
153
|
+
total_amount?: number | undefined;
|
|
154
|
+
currency_code?: string | undefined;
|
|
155
|
+
financial_status?: string | undefined;
|
|
156
|
+
fulfillment_status?: string | undefined;
|
|
157
|
+
order_url?: string | undefined;
|
|
158
|
+
notes?: string | undefined;
|
|
159
|
+
metadata?: {
|
|
160
|
+
part_number?: string | undefined;
|
|
161
|
+
quantity?: number | undefined;
|
|
162
|
+
description?: string | undefined;
|
|
163
|
+
line_total?: number | undefined;
|
|
164
|
+
} | undefined;
|
|
165
|
+
};
|
|
166
|
+
}, {
|
|
167
|
+
order: {
|
|
168
|
+
source_id: string;
|
|
169
|
+
source: string;
|
|
170
|
+
name?: string | undefined;
|
|
171
|
+
contact_id?: number | undefined;
|
|
172
|
+
total_amount?: number | undefined;
|
|
173
|
+
currency_code?: string | undefined;
|
|
174
|
+
financial_status?: string | undefined;
|
|
175
|
+
fulfillment_status?: string | undefined;
|
|
176
|
+
order_url?: string | undefined;
|
|
177
|
+
notes?: string | undefined;
|
|
178
|
+
metadata?: {
|
|
179
|
+
part_number?: string | undefined;
|
|
180
|
+
quantity?: number | undefined;
|
|
181
|
+
description?: string | undefined;
|
|
182
|
+
line_total?: number | undefined;
|
|
183
|
+
} | undefined;
|
|
184
|
+
};
|
|
185
|
+
}>;
|
|
186
|
+
export declare const UpsertOrderResponsePayloadSchema: z.ZodObject<{
|
|
187
|
+
id: z.ZodNumber;
|
|
188
|
+
name: z.ZodOptional<z.ZodString>;
|
|
189
|
+
contact_id: z.ZodOptional<z.ZodNumber>;
|
|
190
|
+
contact_name: z.ZodOptional<z.ZodString>;
|
|
191
|
+
total_amount: z.ZodOptional<z.ZodNumber>;
|
|
192
|
+
currency_code: z.ZodOptional<z.ZodString>;
|
|
193
|
+
financial_status: z.ZodOptional<z.ZodString>;
|
|
194
|
+
fulfillment_status: z.ZodOptional<z.ZodString>;
|
|
195
|
+
source: z.ZodString;
|
|
196
|
+
source_id: z.ZodString;
|
|
197
|
+
order_url: z.ZodOptional<z.ZodString>;
|
|
198
|
+
notes: z.ZodOptional<z.ZodString>;
|
|
199
|
+
metadata: z.ZodOptional<z.ZodObject<{
|
|
200
|
+
part_number: z.ZodOptional<z.ZodString>;
|
|
201
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
202
|
+
description: z.ZodOptional<z.ZodString>;
|
|
203
|
+
line_total: z.ZodOptional<z.ZodNumber>;
|
|
204
|
+
}, "strip", z.ZodTypeAny, {
|
|
205
|
+
part_number?: string | undefined;
|
|
206
|
+
quantity?: number | undefined;
|
|
207
|
+
description?: string | undefined;
|
|
208
|
+
line_total?: number | undefined;
|
|
209
|
+
}, {
|
|
210
|
+
part_number?: string | undefined;
|
|
211
|
+
quantity?: number | undefined;
|
|
212
|
+
description?: string | undefined;
|
|
213
|
+
line_total?: number | undefined;
|
|
214
|
+
}>>;
|
|
215
|
+
created_at: z.ZodString;
|
|
216
|
+
updated_at: z.ZodString;
|
|
217
|
+
}, "strip", z.ZodTypeAny, {
|
|
218
|
+
id: number;
|
|
219
|
+
created_at: string;
|
|
220
|
+
source_id: string;
|
|
221
|
+
updated_at: string;
|
|
222
|
+
source: string;
|
|
223
|
+
name?: string | undefined;
|
|
224
|
+
contact_id?: number | undefined;
|
|
225
|
+
total_amount?: number | undefined;
|
|
226
|
+
currency_code?: string | undefined;
|
|
227
|
+
financial_status?: string | undefined;
|
|
228
|
+
fulfillment_status?: string | undefined;
|
|
229
|
+
order_url?: string | undefined;
|
|
230
|
+
notes?: string | undefined;
|
|
231
|
+
metadata?: {
|
|
232
|
+
part_number?: string | undefined;
|
|
233
|
+
quantity?: number | undefined;
|
|
234
|
+
description?: string | undefined;
|
|
235
|
+
line_total?: number | undefined;
|
|
236
|
+
} | undefined;
|
|
237
|
+
contact_name?: string | undefined;
|
|
238
|
+
}, {
|
|
239
|
+
id: number;
|
|
240
|
+
created_at: string;
|
|
241
|
+
source_id: string;
|
|
242
|
+
updated_at: string;
|
|
243
|
+
source: string;
|
|
244
|
+
name?: string | undefined;
|
|
245
|
+
contact_id?: number | undefined;
|
|
246
|
+
total_amount?: number | undefined;
|
|
247
|
+
currency_code?: string | undefined;
|
|
248
|
+
financial_status?: string | undefined;
|
|
249
|
+
fulfillment_status?: string | undefined;
|
|
250
|
+
order_url?: string | undefined;
|
|
251
|
+
notes?: string | undefined;
|
|
252
|
+
metadata?: {
|
|
253
|
+
part_number?: string | undefined;
|
|
254
|
+
quantity?: number | undefined;
|
|
255
|
+
description?: string | undefined;
|
|
256
|
+
line_total?: number | undefined;
|
|
257
|
+
} | undefined;
|
|
258
|
+
contact_name?: string | undefined;
|
|
259
|
+
}>;
|
|
260
|
+
export declare const UpsertOrderResponseSchema: z.ZodObject<{
|
|
261
|
+
payload: z.ZodObject<{
|
|
262
|
+
id: z.ZodNumber;
|
|
263
|
+
name: z.ZodOptional<z.ZodString>;
|
|
264
|
+
contact_id: z.ZodOptional<z.ZodNumber>;
|
|
265
|
+
contact_name: z.ZodOptional<z.ZodString>;
|
|
266
|
+
total_amount: z.ZodOptional<z.ZodNumber>;
|
|
267
|
+
currency_code: z.ZodOptional<z.ZodString>;
|
|
268
|
+
financial_status: z.ZodOptional<z.ZodString>;
|
|
269
|
+
fulfillment_status: z.ZodOptional<z.ZodString>;
|
|
270
|
+
source: z.ZodString;
|
|
271
|
+
source_id: z.ZodString;
|
|
272
|
+
order_url: z.ZodOptional<z.ZodString>;
|
|
273
|
+
notes: z.ZodOptional<z.ZodString>;
|
|
274
|
+
metadata: z.ZodOptional<z.ZodObject<{
|
|
275
|
+
part_number: z.ZodOptional<z.ZodString>;
|
|
276
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
277
|
+
description: z.ZodOptional<z.ZodString>;
|
|
278
|
+
line_total: z.ZodOptional<z.ZodNumber>;
|
|
279
|
+
}, "strip", z.ZodTypeAny, {
|
|
280
|
+
part_number?: string | undefined;
|
|
281
|
+
quantity?: number | undefined;
|
|
282
|
+
description?: string | undefined;
|
|
283
|
+
line_total?: number | undefined;
|
|
284
|
+
}, {
|
|
285
|
+
part_number?: string | undefined;
|
|
286
|
+
quantity?: number | undefined;
|
|
287
|
+
description?: string | undefined;
|
|
288
|
+
line_total?: number | undefined;
|
|
289
|
+
}>>;
|
|
290
|
+
created_at: z.ZodString;
|
|
291
|
+
updated_at: z.ZodString;
|
|
292
|
+
}, "strip", z.ZodTypeAny, {
|
|
293
|
+
id: number;
|
|
294
|
+
created_at: string;
|
|
295
|
+
source_id: string;
|
|
296
|
+
updated_at: string;
|
|
297
|
+
source: string;
|
|
298
|
+
name?: string | undefined;
|
|
299
|
+
contact_id?: number | undefined;
|
|
300
|
+
total_amount?: number | undefined;
|
|
301
|
+
currency_code?: string | undefined;
|
|
302
|
+
financial_status?: string | undefined;
|
|
303
|
+
fulfillment_status?: string | undefined;
|
|
304
|
+
order_url?: string | undefined;
|
|
305
|
+
notes?: string | undefined;
|
|
306
|
+
metadata?: {
|
|
307
|
+
part_number?: string | undefined;
|
|
308
|
+
quantity?: number | undefined;
|
|
309
|
+
description?: string | undefined;
|
|
310
|
+
line_total?: number | undefined;
|
|
311
|
+
} | undefined;
|
|
312
|
+
contact_name?: string | undefined;
|
|
313
|
+
}, {
|
|
314
|
+
id: number;
|
|
315
|
+
created_at: string;
|
|
316
|
+
source_id: string;
|
|
317
|
+
updated_at: string;
|
|
318
|
+
source: string;
|
|
319
|
+
name?: string | undefined;
|
|
320
|
+
contact_id?: number | undefined;
|
|
321
|
+
total_amount?: number | undefined;
|
|
322
|
+
currency_code?: string | undefined;
|
|
323
|
+
financial_status?: string | undefined;
|
|
324
|
+
fulfillment_status?: string | undefined;
|
|
325
|
+
order_url?: string | undefined;
|
|
326
|
+
notes?: string | undefined;
|
|
327
|
+
metadata?: {
|
|
328
|
+
part_number?: string | undefined;
|
|
329
|
+
quantity?: number | undefined;
|
|
330
|
+
description?: string | undefined;
|
|
331
|
+
line_total?: number | undefined;
|
|
332
|
+
} | undefined;
|
|
333
|
+
contact_name?: string | undefined;
|
|
334
|
+
}>;
|
|
335
|
+
}, "strip", z.ZodTypeAny, {
|
|
336
|
+
payload: {
|
|
337
|
+
id: number;
|
|
338
|
+
created_at: string;
|
|
339
|
+
source_id: string;
|
|
340
|
+
updated_at: string;
|
|
341
|
+
source: string;
|
|
342
|
+
name?: string | undefined;
|
|
343
|
+
contact_id?: number | undefined;
|
|
344
|
+
total_amount?: number | undefined;
|
|
345
|
+
currency_code?: string | undefined;
|
|
346
|
+
financial_status?: string | undefined;
|
|
347
|
+
fulfillment_status?: string | undefined;
|
|
348
|
+
order_url?: string | undefined;
|
|
349
|
+
notes?: string | undefined;
|
|
350
|
+
metadata?: {
|
|
351
|
+
part_number?: string | undefined;
|
|
352
|
+
quantity?: number | undefined;
|
|
353
|
+
description?: string | undefined;
|
|
354
|
+
line_total?: number | undefined;
|
|
355
|
+
} | undefined;
|
|
356
|
+
contact_name?: string | undefined;
|
|
357
|
+
};
|
|
358
|
+
}, {
|
|
359
|
+
payload: {
|
|
360
|
+
id: number;
|
|
361
|
+
created_at: string;
|
|
362
|
+
source_id: string;
|
|
363
|
+
updated_at: string;
|
|
364
|
+
source: string;
|
|
365
|
+
name?: string | undefined;
|
|
366
|
+
contact_id?: number | undefined;
|
|
367
|
+
total_amount?: number | undefined;
|
|
368
|
+
currency_code?: string | undefined;
|
|
369
|
+
financial_status?: string | undefined;
|
|
370
|
+
fulfillment_status?: string | undefined;
|
|
371
|
+
order_url?: string | undefined;
|
|
372
|
+
notes?: string | undefined;
|
|
373
|
+
metadata?: {
|
|
374
|
+
part_number?: string | undefined;
|
|
375
|
+
quantity?: number | undefined;
|
|
376
|
+
description?: string | undefined;
|
|
377
|
+
line_total?: number | undefined;
|
|
378
|
+
} | undefined;
|
|
379
|
+
contact_name?: string | undefined;
|
|
380
|
+
};
|
|
381
|
+
}>;
|
|
382
|
+
export declare const ListOrdersParamsSchema: z.ZodObject<{
|
|
383
|
+
page: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
|
|
384
|
+
per_page: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
|
|
385
|
+
since: z.ZodOptional<z.ZodString>;
|
|
386
|
+
until: z.ZodOptional<z.ZodString>;
|
|
387
|
+
sort: z.ZodOptional<z.ZodString>;
|
|
388
|
+
payload: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
|
|
389
|
+
}, "strip", z.ZodTypeAny, {
|
|
390
|
+
page: number;
|
|
391
|
+
per_page: number;
|
|
392
|
+
sort?: string | undefined;
|
|
393
|
+
payload?: Record<string, unknown>[] | undefined;
|
|
394
|
+
since?: string | undefined;
|
|
395
|
+
until?: string | undefined;
|
|
396
|
+
}, {
|
|
397
|
+
sort?: string | undefined;
|
|
398
|
+
payload?: Record<string, unknown>[] | undefined;
|
|
399
|
+
page?: number | undefined;
|
|
400
|
+
per_page?: number | undefined;
|
|
401
|
+
since?: string | undefined;
|
|
402
|
+
until?: string | undefined;
|
|
403
|
+
}>;
|
|
404
|
+
export declare const OrdersMetaSchema: z.ZodObject<{
|
|
405
|
+
count: z.ZodNumber;
|
|
406
|
+
current_page: z.ZodNumber;
|
|
407
|
+
per_page: z.ZodNumber;
|
|
408
|
+
total_pages: z.ZodNumber;
|
|
409
|
+
summary: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
410
|
+
}, "strip", z.ZodTypeAny, {
|
|
411
|
+
per_page: number;
|
|
412
|
+
count: number;
|
|
413
|
+
current_page: number;
|
|
414
|
+
total_pages: number;
|
|
415
|
+
summary: Record<string, unknown>;
|
|
416
|
+
}, {
|
|
417
|
+
per_page: number;
|
|
418
|
+
count: number;
|
|
419
|
+
current_page: number;
|
|
420
|
+
total_pages: number;
|
|
421
|
+
summary: Record<string, unknown>;
|
|
422
|
+
}>;
|
|
423
|
+
export declare const ListOrdersResponseSchema: z.ZodObject<{
|
|
424
|
+
meta: z.ZodObject<{
|
|
425
|
+
count: z.ZodNumber;
|
|
426
|
+
current_page: z.ZodNumber;
|
|
427
|
+
per_page: z.ZodNumber;
|
|
428
|
+
total_pages: z.ZodNumber;
|
|
429
|
+
summary: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
430
|
+
}, "strip", z.ZodTypeAny, {
|
|
431
|
+
per_page: number;
|
|
432
|
+
count: number;
|
|
433
|
+
current_page: number;
|
|
434
|
+
total_pages: number;
|
|
435
|
+
summary: Record<string, unknown>;
|
|
436
|
+
}, {
|
|
437
|
+
per_page: number;
|
|
438
|
+
count: number;
|
|
439
|
+
current_page: number;
|
|
440
|
+
total_pages: number;
|
|
441
|
+
summary: Record<string, unknown>;
|
|
442
|
+
}>;
|
|
443
|
+
data: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
|
|
444
|
+
}, "strip", z.ZodTypeAny, {
|
|
445
|
+
meta: {
|
|
446
|
+
per_page: number;
|
|
447
|
+
count: number;
|
|
448
|
+
current_page: number;
|
|
449
|
+
total_pages: number;
|
|
450
|
+
summary: Record<string, unknown>;
|
|
451
|
+
};
|
|
452
|
+
data: Record<string, unknown>[];
|
|
453
|
+
}, {
|
|
454
|
+
meta: {
|
|
455
|
+
per_page: number;
|
|
456
|
+
count: number;
|
|
457
|
+
current_page: number;
|
|
458
|
+
total_pages: number;
|
|
459
|
+
summary: Record<string, unknown>;
|
|
460
|
+
};
|
|
461
|
+
data: Record<string, unknown>[];
|
|
462
|
+
}>;
|
|
463
|
+
/**
|
|
464
|
+
* TypeScript Types (inferred from Zod schemas)
|
|
465
|
+
*/
|
|
466
|
+
export type Order = z.infer<typeof OrderSchema>;
|
|
467
|
+
export type ListOrdersParams = z.infer<typeof ListOrdersParamsSchema>;
|
|
468
|
+
export type OrdersMeta = z.infer<typeof OrdersMetaSchema>;
|
|
469
|
+
export type ListOrdersResponse = z.infer<typeof ListOrdersResponseSchema>;
|
|
470
|
+
export type UpsertOrderParams = z.infer<typeof UpsertOrderParamsSchema>;
|
|
471
|
+
export type UpsertOrderRequest = z.infer<typeof UpsertOrderRequestSchema>;
|
|
472
|
+
export type UpsertOrderResponsePayload = z.infer<typeof UpsertOrderResponsePayloadSchema>;
|
|
473
|
+
export type UpsertOrderResponse = z.infer<typeof UpsertOrderResponseSchema>;
|
|
474
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../resources/orders/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AAGH,eAAO,MAAM,WAAW,wCAAwB,CAAC;AAEjD,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;EAK9B,CAAC;AAGH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYlC,CAAC;AAGH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEnC,CAAC;AAGH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgB3C,CAAC;AAGH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEpC,CAAC;AAGH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;EAOjC,CAAC;AAGH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;EAM3B,CAAC;AAGH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGnC,CAAC;AAEH;;GAEG;AAEH,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,gCAAgC,CACxC,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC"}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
/**
|
|
3
|
+
* Zod Schemas for Orders
|
|
4
|
+
*/
|
|
5
|
+
// Order schema - minimal structure as per API docs
|
|
6
|
+
export const OrderSchema = z.record(z.unknown());
|
|
7
|
+
export const OrderMetadataSchema = z.object({
|
|
8
|
+
part_number: z.string().optional(),
|
|
9
|
+
quantity: z.number().optional(),
|
|
10
|
+
description: z.string().optional(),
|
|
11
|
+
line_total: z.number().optional(),
|
|
12
|
+
});
|
|
13
|
+
// Upsert order parameters schema
|
|
14
|
+
export const UpsertOrderParamsSchema = z.object({
|
|
15
|
+
name: z.string().optional(),
|
|
16
|
+
contact_id: z.number().optional(),
|
|
17
|
+
total_amount: z.number().optional(),
|
|
18
|
+
currency_code: z.string().optional(),
|
|
19
|
+
financial_status: z.string().optional(),
|
|
20
|
+
fulfillment_status: z.string().optional(),
|
|
21
|
+
source: z.string(),
|
|
22
|
+
source_id: z.string(),
|
|
23
|
+
order_url: z.string().optional(),
|
|
24
|
+
notes: z.string().optional(),
|
|
25
|
+
metadata: OrderMetadataSchema.optional(),
|
|
26
|
+
});
|
|
27
|
+
// Upsert order request schema (wraps order in an object)
|
|
28
|
+
export const UpsertOrderRequestSchema = z.object({
|
|
29
|
+
order: UpsertOrderParamsSchema,
|
|
30
|
+
});
|
|
31
|
+
// Upsert order response payload schema
|
|
32
|
+
export const UpsertOrderResponsePayloadSchema = z.object({
|
|
33
|
+
id: z.number(),
|
|
34
|
+
name: z.string().optional(),
|
|
35
|
+
contact_id: z.number().optional(),
|
|
36
|
+
contact_name: z.string().optional(),
|
|
37
|
+
total_amount: z.number().optional(),
|
|
38
|
+
currency_code: z.string().optional(),
|
|
39
|
+
financial_status: z.string().optional(),
|
|
40
|
+
fulfillment_status: z.string().optional(),
|
|
41
|
+
source: z.string(),
|
|
42
|
+
source_id: z.string(),
|
|
43
|
+
order_url: z.string().optional(),
|
|
44
|
+
notes: z.string().optional(),
|
|
45
|
+
metadata: OrderMetadataSchema.optional(),
|
|
46
|
+
created_at: z.string(),
|
|
47
|
+
updated_at: z.string(),
|
|
48
|
+
});
|
|
49
|
+
// Upsert order response schema
|
|
50
|
+
export const UpsertOrderResponseSchema = z.object({
|
|
51
|
+
payload: UpsertOrderResponsePayloadSchema,
|
|
52
|
+
});
|
|
53
|
+
// List orders query parameters schema
|
|
54
|
+
export const ListOrdersParamsSchema = z.object({
|
|
55
|
+
page: z.number().int().positive().optional().default(1),
|
|
56
|
+
per_page: z.number().int().positive().max(100).optional().default(25),
|
|
57
|
+
since: z.string().optional(),
|
|
58
|
+
until: z.string().optional(),
|
|
59
|
+
sort: z.string().optional(),
|
|
60
|
+
payload: z.array(z.record(z.unknown())).optional(),
|
|
61
|
+
});
|
|
62
|
+
// List orders response meta schema
|
|
63
|
+
export const OrdersMetaSchema = z.object({
|
|
64
|
+
count: z.number(),
|
|
65
|
+
current_page: z.number(),
|
|
66
|
+
per_page: z.number(),
|
|
67
|
+
total_pages: z.number(),
|
|
68
|
+
summary: z.record(z.unknown()),
|
|
69
|
+
});
|
|
70
|
+
// List orders response schema
|
|
71
|
+
export const ListOrdersResponseSchema = z.object({
|
|
72
|
+
meta: OrdersMetaSchema,
|
|
73
|
+
data: z.array(OrderSchema),
|
|
74
|
+
});
|
|
75
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../resources/orders/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AAEH,mDAAmD;AACnD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;AAEjD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC;AAEH,iCAAiC;AACjC,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH,yDAAyD;AACzD,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,KAAK,EAAE,uBAAuB;CAC/B,CAAC,CAAC;AAEH,uCAAuC;AACvC,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACxC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;CACvB,CAAC,CAAC;AAEH,+BAA+B;AAC/B,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,EAAE,gCAAgC;CAC1C,CAAC,CAAC;AAEH,sCAAsC;AACtC,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACvD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACrE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACnD,CAAC,CAAC;AAEH,mCAAmC;AACnC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CAC/B,CAAC,CAAC;AAEH,8BAA8B;AAC9B,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC;CAC3B,CAAC,CAAC"}
|
package/dist/test.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../test.ts"],"names":[],"mappings":"AAAA;;;GAGG"}
|
package/dist/test.js
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Test script for all GET endpoints in Envoy SDK
|
|
3
|
+
* Run with: npx tsx test.ts or npm run test:get
|
|
4
|
+
*/
|
|
5
|
+
import { EnvoyClient } from './index.js';
|
|
6
|
+
// Configuration - Replace with your actual credentials
|
|
7
|
+
const config = {
|
|
8
|
+
apiKey: process.env.ENVOY_API_KEY || 'your-api-key-here',
|
|
9
|
+
accountId: process.env.ENVOY_ACCOUNT_ID || 'your-account-id-here',
|
|
10
|
+
baseUrl: process.env.ENVOY_BASE_URL || 'https://envoy-crm.voltade.com',
|
|
11
|
+
};
|
|
12
|
+
async function testGetEndpoints() {
|
|
13
|
+
console.log('🚀 Initializing Envoy Client...\n');
|
|
14
|
+
const client = new EnvoyClient(config);
|
|
15
|
+
try {
|
|
16
|
+
// ========================================
|
|
17
|
+
// ORDERS API - GET ENDPOINTS
|
|
18
|
+
// ========================================
|
|
19
|
+
console.log('\n' + '='.repeat(60));
|
|
20
|
+
console.log('📦 ORDERS API - GET ENDPOINTS');
|
|
21
|
+
console.log('='.repeat(60) + '\n');
|
|
22
|
+
// Test 1: List Orders (default pagination)
|
|
23
|
+
console.log('📋 Test 1: List Orders (Default Pagination)');
|
|
24
|
+
console.log('-'.repeat(50));
|
|
25
|
+
const listResponse = await client.orders.list({
|
|
26
|
+
page: 1,
|
|
27
|
+
per_page: 10,
|
|
28
|
+
});
|
|
29
|
+
console.log('✅ Success!');
|
|
30
|
+
console.log('Meta:', JSON.stringify(listResponse.meta, null, 2));
|
|
31
|
+
console.log(`Found ${listResponse.data.length} orders`);
|
|
32
|
+
if (listResponse.data.length > 0) {
|
|
33
|
+
console.log('First order sample:', JSON.stringify(listResponse.data[0], null, 2));
|
|
34
|
+
}
|
|
35
|
+
console.log('\n');
|
|
36
|
+
// Test 2: List Orders with Filters
|
|
37
|
+
console.log('📋 Test 2: List Orders with Filters');
|
|
38
|
+
console.log('-'.repeat(50));
|
|
39
|
+
const filteredResponse = await client.orders.list({
|
|
40
|
+
page: 1,
|
|
41
|
+
per_page: 5,
|
|
42
|
+
sort: '-created_at',
|
|
43
|
+
});
|
|
44
|
+
console.log('✅ Success!');
|
|
45
|
+
console.log('Meta:', JSON.stringify(filteredResponse.meta, null, 2));
|
|
46
|
+
console.log(`Found ${filteredResponse.data.length} orders`);
|
|
47
|
+
console.log('\n');
|
|
48
|
+
// ========================================
|
|
49
|
+
// CONVERSATIONS API - GET ENDPOINTS
|
|
50
|
+
// ========================================
|
|
51
|
+
console.log('='.repeat(60));
|
|
52
|
+
console.log('💬 CONVERSATIONS API - GET ENDPOINTS');
|
|
53
|
+
console.log('='.repeat(60) + '\n');
|
|
54
|
+
// Test 3: Get Conversation
|
|
55
|
+
console.log('📋 Test 3: Get Conversation by ID');
|
|
56
|
+
console.log('-'.repeat(50));
|
|
57
|
+
// Note: Replace with an actual conversation ID from your system
|
|
58
|
+
const conversationId = 1; // Change this to a valid conversation ID
|
|
59
|
+
try {
|
|
60
|
+
const conversation = await client.conversations.get(conversationId);
|
|
61
|
+
console.log('✅ Success!');
|
|
62
|
+
console.log('Conversation ID:', conversation.id);
|
|
63
|
+
console.log('Status:', conversation.status);
|
|
64
|
+
console.log('Account ID:', conversation.account_id);
|
|
65
|
+
console.log('Inbox ID:', conversation.inbox_id);
|
|
66
|
+
console.log('Full conversation:', JSON.stringify(conversation, null, 2));
|
|
67
|
+
}
|
|
68
|
+
catch (error) {
|
|
69
|
+
console.log('⚠️ Skipped (conversation not found or invalid ID)');
|
|
70
|
+
console.log('Error:', error.message);
|
|
71
|
+
}
|
|
72
|
+
console.log('\n');
|
|
73
|
+
// Test 4: Get Messages
|
|
74
|
+
console.log('📋 Test 4: Get Conversation Messages');
|
|
75
|
+
console.log('-'.repeat(50));
|
|
76
|
+
try {
|
|
77
|
+
const messages = await client.conversations.getMessages(conversationId);
|
|
78
|
+
console.log('✅ Success!');
|
|
79
|
+
console.log('Meta:', JSON.stringify(messages.meta, null, 2));
|
|
80
|
+
console.log(`Found ${messages.payload.length} messages`);
|
|
81
|
+
if (messages.payload.length > 0) {
|
|
82
|
+
console.log('First message:', JSON.stringify(messages.payload[0], null, 2));
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
catch (error) {
|
|
86
|
+
console.log('⚠️ Skipped (conversation not found or invalid ID)');
|
|
87
|
+
console.log('Error:', error.message);
|
|
88
|
+
}
|
|
89
|
+
console.log('\n');
|
|
90
|
+
// ========================================
|
|
91
|
+
// TEST SUMMARY
|
|
92
|
+
// ========================================
|
|
93
|
+
console.log('='.repeat(60));
|
|
94
|
+
console.log('🎉 All GET endpoint tests completed!');
|
|
95
|
+
console.log('='.repeat(60));
|
|
96
|
+
}
|
|
97
|
+
catch (error) {
|
|
98
|
+
console.error('\n' + '='.repeat(60));
|
|
99
|
+
console.error('❌ Test failed with error:');
|
|
100
|
+
console.error('='.repeat(60));
|
|
101
|
+
console.error('Error name:', error.name);
|
|
102
|
+
console.error('Error message:', error.message);
|
|
103
|
+
if (error.response) {
|
|
104
|
+
console.error('Response data:', JSON.stringify(error.response, null, 2));
|
|
105
|
+
}
|
|
106
|
+
if (error.statusCode) {
|
|
107
|
+
console.error('Status code:', error.statusCode);
|
|
108
|
+
}
|
|
109
|
+
console.error('='.repeat(60));
|
|
110
|
+
process.exit(1);
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
// Run tests
|
|
114
|
+
testGetEndpoints();
|
|
115
|
+
//# sourceMappingURL=test.js.map
|
package/dist/test.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"test.js","sourceRoot":"","sources":["../test.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,uDAAuD;AACvD,MAAM,MAAM,GAAG;IACb,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,mBAAmB;IACxD,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,sBAAsB;IACjE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,+BAA+B;CACvE,CAAC;AAEF,KAAK,UAAU,gBAAgB;IAC7B,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IAEvC,IAAI,CAAC;QACH,2CAA2C;QAC3C,6BAA6B;QAC7B,2CAA2C;QAC3C,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAEnC,2CAA2C;QAC3C,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;QAC3D,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAE5B,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;YAC5C,IAAI,EAAE,CAAC;YACP,QAAQ,EAAE,EAAE;SACb,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACjE,OAAO,CAAC,GAAG,CAAC,SAAS,YAAY,CAAC,IAAI,CAAC,MAAM,SAAS,CAAC,CAAC;QACxD,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACpF,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAElB,mCAAmC;QACnC,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAE5B,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;YAChD,IAAI,EAAE,CAAC;YACP,QAAQ,EAAE,CAAC;YACX,IAAI,EAAE,aAAa;SACpB,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACrE,OAAO,CAAC,GAAG,CAAC,SAAS,gBAAgB,CAAC,IAAI,CAAC,MAAM,SAAS,CAAC,CAAC;QAC5D,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAElB,2CAA2C;QAC3C,oCAAoC;QACpC,2CAA2C;QAC3C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;QACpD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAEnC,2BAA2B;QAC3B,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;QACjD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAE5B,gEAAgE;QAChE,MAAM,cAAc,GAAG,CAAC,CAAC,CAAC,yCAAyC;QACnE,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YACpE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC;YACjD,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;YAC5C,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;YACpD,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;YAChD,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3E,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,oDAAoD,CAAC,CAAC;YAClE,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAElB,uBAAuB;QACvB,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;QACpD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAE5B,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;YACxE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAC7D,OAAO,CAAC,GAAG,CAAC,SAAS,QAAQ,CAAC,OAAO,CAAC,MAAM,WAAW,CAAC,CAAC;YACzD,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAC9E,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,oDAAoD,CAAC,CAAC;YAClE,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAElB,2CAA2C;QAC3C,eAAe;QACf,2CAA2C;QAC3C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;QACpD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAE9B,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QACrC,OAAO,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC3C,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,YAAY;AACZ,gBAAgB,EAAE,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@voltade/envoy-sdk",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A comprehensive TypeScript SDK for the Envoy API with built-in error handling and resource-based architecture",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -38,6 +38,7 @@
|
|
|
38
38
|
"clean": "rm -rf dist",
|
|
39
39
|
"prepublishOnly": "npm run clean && npm run build",
|
|
40
40
|
"test": "echo \"Error: no test specified\" && exit 1",
|
|
41
|
+
"test:get": "tsx test.ts",
|
|
41
42
|
"lint": "tsc --noEmit"
|
|
42
43
|
},
|
|
43
44
|
"keywords": [
|
|
@@ -73,6 +74,7 @@
|
|
|
73
74
|
},
|
|
74
75
|
"devDependencies": {
|
|
75
76
|
"@types/node": "^20.0.0",
|
|
77
|
+
"tsx": "^4.21.0",
|
|
76
78
|
"typescript": "^5.0.0"
|
|
77
79
|
}
|
|
78
80
|
}
|