@voltade/envoy-sdk 1.0.4 → 1.1.0

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 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)
@@ -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;AAE9D;;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;gBAErB,MAAM,EAAE,iBAAiB;IAYrC;;;OAGG;IACH,aAAa,IAAI,UAAU;CAG5B"}
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)
@@ -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;AAY9D;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,WAAW;IAatB,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;IAC9C,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF"}
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
@@ -22,10 +22,11 @@
22
22
  * const result = await client.conversations.escalateToHuman(123);
23
23
  * ```
24
24
  */
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';
27
- export { Conversations, Inboxes } from './resources/index.js';
28
- 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';
29
- export { HttpClient } from './http-client.js';
30
- export { AuthenticationError, BadRequestError, EnvoyError, NetworkError, NotFoundError, RateLimitError, ServerError, ValidationError, } from './errors.js';
25
+ export { EnvoyClient, type EnvoyClientConfig } from "./client.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
+ export { webhookEvent } from "./resources/webhooks/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
+ export { HttpClient } from "./http-client.js";
31
+ export { AuthenticationError, BadRequestError, EnvoyError, NetworkError, NotFoundError, RateLimitError, ServerError, ValidationError, } from "./errors.js";
31
32
  //# sourceMappingURL=index.d.ts.map
@@ -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,aAAa,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG9D,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,aAAa,EACb,0BAA0B,EAC1B,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,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"}
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
@@ -23,12 +23,13 @@
23
23
  * ```
24
24
  */
25
25
  // Main client export
26
- export { EnvoyClient } from './client.js';
27
- export { Conversations, Inboxes } from './resources/index.js';
26
+ export { EnvoyClient } from "./client.js";
27
+ export { webhookEvent } from "./resources/webhooks/index.js";
28
+ export { Conversations, Inboxes, Orders } from './resources/index.js';
28
29
  // Zod schema exports
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';
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";
30
31
  // Utility exports
31
- export { HttpClient } from './http-client.js';
32
+ export { HttpClient } from "./http-client.js";
32
33
  // Error exports
33
- export { AuthenticationError, BadRequestError, EnvoyError, NetworkError, NotFoundError, RateLimitError, ServerError, ValidationError, } from './errors.js';
34
+ export { AuthenticationError, BadRequestError, EnvoyError, NetworkError, NotFoundError, RateLimitError, ServerError, ValidationError, } from "./errors.js";
34
35
  //# sourceMappingURL=index.js.map
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;AAyBlE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE9D,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,aAAa,EACb,0BAA0B,EAC1B,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,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
+ {"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"}
@@ -4,5 +4,6 @@
4
4
  */
5
5
  export * from "./conversations/index.js";
6
6
  export * from "./inboxes/index.js";
7
+ export * from "./orders/index.js";
7
8
  export * from "./webhooks/index.js";
8
9
  //# sourceMappingURL=index.d.ts.map
@@ -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"}
@@ -4,5 +4,6 @@
4
4
  */
5
5
  export * from "./conversations/index.js";
6
6
  export * from "./inboxes/index.js";
7
+ export * from "./orders/index.js";
7
8
  export * from "./webhooks/index.js";
8
9
  //# sourceMappingURL=index.js.map
@@ -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"}