@voltade/envoy-sdk 1.4.4 → 1.5.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/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/companies/index.d.ts +35 -14
- package/dist/resources/companies/index.d.ts.map +1 -1
- package/dist/resources/companies/index.js +35 -12
- package/dist/resources/companies/index.js.map +1 -1
- package/dist/resources/companies/types.d.ts +301 -82
- package/dist/resources/companies/types.d.ts.map +1 -1
- package/dist/resources/companies/types.js +36 -5
- package/dist/resources/companies/types.js.map +1 -1
- package/dist/resources/contacts/index.d.ts +211 -18
- package/dist/resources/contacts/index.d.ts.map +1 -1
- package/dist/resources/contacts/index.js +279 -14
- package/dist/resources/contacts/index.js.map +1 -1
- package/dist/resources/contacts/types.d.ts +643 -0
- package/dist/resources/contacts/types.d.ts.map +1 -1
- package/dist/resources/contacts/types.js +168 -1
- package/dist/resources/contacts/types.js.map +1 -1
- package/dist/resources/orders/index.d.ts +110 -17
- package/dist/resources/orders/index.d.ts.map +1 -1
- package/dist/resources/orders/index.js +136 -16
- package/dist/resources/orders/index.js.map +1 -1
- package/dist/resources/orders/types.d.ts +2732 -290
- package/dist/resources/orders/types.d.ts.map +1 -1
- package/dist/resources/orders/types.js +125 -19
- package/dist/resources/orders/types.js.map +1 -1
- package/dist/test/bulk-order-upsert.d.ts +6 -0
- package/dist/test/bulk-order-upsert.d.ts.map +1 -0
- package/dist/test/bulk-order-upsert.js +122 -0
- package/dist/test/bulk-order-upsert.js.map +1 -0
- package/package.json +1 -1
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, ListOrdersParams, ListOrdersResponse, Message, MessageType, MessagesResponse, MessagesResponseMeta, Order, OrdersMeta, Priority, UpsertOrderParams, UpsertOrderRequest, UpsertOrderResponse,
|
|
26
|
+
export type { Agent, Article, Assignee, Contact, ContactInbox, Conversation, ConversationMeta, ConversationStatus, ContentType, CreateMessageParams, CreateOrderParams, CreateOrderResponse, EscalationResponse, EscalationType, GetOrderResponse, ListOrdersParams, ListOrdersResponse, Message, MessageType, MessagesResponse, MessagesResponseMeta, Order, OrdersMeta, OrdersSummary, Priority, UpdateOrderParams, UpdateOrderResponse, UpsertOrderParams, UpsertOrderRequest, UpsertOrderResponse, BulkUpsertOrderItem, BulkUpsertOrdersResponse, SearchParams, SearchResponse, Team, } from "./resources/index.js";
|
|
27
27
|
export { webhookEvent } from "./resources/webhooks/index.js";
|
|
28
|
-
export { Conversations, Inboxes, Orders } from
|
|
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,
|
|
28
|
+
export { Conversations, Inboxes, Orders } from "./resources/index.js";
|
|
29
|
+
export { AgentSchema, ArticleSchema, AssigneeSchema, ContactInboxSchema, ContactSchema, ConversationMetaSchema, ConversationSchema, ConversationStatusSchema, ContentTypeSchema, CreateMessageParamsSchema, CreateOrderParamsSchema, CreateOrderResponseSchema, EscalationResponseSchema, EscalationTypeSchema, GetOrderResponseSchema, ListOrdersParamsSchema, ListOrdersResponseSchema, MessageSchema, MessagesResponseMetaSchema, MessagesResponseSchema, MessageTypeSchema, OrdersMetaSchema, OrdersSummarySchema, OrderSchema, PrioritySchema, UpdateOrderParamsSchema, UpdateOrderResponseSchema, UpsertOrderParamsSchema, UpsertOrderRequestSchema, UpsertOrderResponseSchema, BulkUpsertOrderItemSchema, BulkUpsertOrdersResponseSchema, 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,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,WAAW,EACX,gBAAgB,EAChB,oBAAoB,EACpB,KAAK,EACL,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,
|
|
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,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,WAAW,EACX,gBAAgB,EAChB,oBAAoB,EACpB,KAAK,EACL,UAAU,EACV,aAAa,EACb,QAAQ,EACR,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,wBAAwB,EACxB,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,uBAAuB,EACvB,yBAAyB,EACzB,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,aAAa,EACb,0BAA0B,EAC1B,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,cAAc,EACd,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,8BAA8B,EAC9B,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, Orders } 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, ListOrdersParamsSchema, ListOrdersResponseSchema, MessageSchema, MessagesResponseMetaSchema, MessagesResponseSchema, MessageTypeSchema, OrdersMetaSchema, OrderSchema, PrioritySchema, UpsertOrderParamsSchema, UpsertOrderRequestSchema,
|
|
30
|
+
export { AgentSchema, ArticleSchema, AssigneeSchema, ContactInboxSchema, ContactSchema, ConversationMetaSchema, ConversationSchema, ConversationStatusSchema, ContentTypeSchema, CreateMessageParamsSchema, CreateOrderParamsSchema, CreateOrderResponseSchema, EscalationResponseSchema, EscalationTypeSchema, GetOrderResponseSchema, ListOrdersParamsSchema, ListOrdersResponseSchema, MessageSchema, MessagesResponseMetaSchema, MessagesResponseSchema, MessageTypeSchema, OrdersMetaSchema, OrdersSummarySchema, OrderSchema, PrioritySchema, UpdateOrderParamsSchema, UpdateOrderResponseSchema, UpsertOrderParamsSchema, UpsertOrderRequestSchema, UpsertOrderResponseSchema, BulkUpsertOrderItemSchema, BulkUpsertOrdersResponseSchema, 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;AAwClE,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,uBAAuB,EACvB,yBAAyB,EACzB,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,aAAa,EACb,0BAA0B,EAC1B,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,cAAc,EACd,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,8BAA8B,EAC9B,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"}
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
import type { HttpClient } from "../../http-client.js";
|
|
6
6
|
import { BaseResource } from "../base-resource.js";
|
|
7
7
|
import { CompanyMembers } from "../company-members/index.js";
|
|
8
|
-
import type { CreateCompanyParams, CreateCompanyResponse, GetCompanyResponse, ListCompaniesParams, ListCompaniesResponse, SearchCompaniesResponse, UpdateCompanyParams, UpdateCompanyResponse } from "./types.js";
|
|
8
|
+
import type { CompanyOrdersParams, CompanyOrdersResponse, CreateCompanyParams, CreateCompanyResponse, GetCompanyResponse, ListCompaniesParams, ListCompaniesResponse, SearchCompaniesResponse, UpdateCompanyParams, UpdateCompanyResponse } from "./types.js";
|
|
9
9
|
/**
|
|
10
10
|
* Companies resource class for managing company-related operations
|
|
11
11
|
*/
|
|
@@ -17,16 +17,21 @@ export declare class Companies extends BaseResource {
|
|
|
17
17
|
constructor(client: HttpClient);
|
|
18
18
|
/**
|
|
19
19
|
* List all companies
|
|
20
|
-
* @param params - Pagination parameters
|
|
21
|
-
* @returns List of companies
|
|
20
|
+
* @param params - Pagination and filter parameters
|
|
21
|
+
* @returns List of companies with metadata
|
|
22
22
|
*
|
|
23
23
|
* @example
|
|
24
24
|
* ```typescript
|
|
25
|
-
* const
|
|
26
|
-
* console.log(
|
|
25
|
+
* const response = await client.companies.list();
|
|
26
|
+
* console.log(response.payload); // Array of companies
|
|
27
|
+
* console.log(response.meta); // { count, current_page }
|
|
27
28
|
*
|
|
28
|
-
* // With pagination
|
|
29
|
-
* const
|
|
29
|
+
* // With pagination and sorting
|
|
30
|
+
* const response = await client.companies.list({
|
|
31
|
+
* page: 2,
|
|
32
|
+
* per_page: 50,
|
|
33
|
+
* sort: '-updated_at'
|
|
34
|
+
* });
|
|
30
35
|
* ```
|
|
31
36
|
*/
|
|
32
37
|
list(params?: ListCompaniesParams): Promise<ListCompaniesResponse>;
|
|
@@ -38,7 +43,8 @@ export declare class Companies extends BaseResource {
|
|
|
38
43
|
* @example
|
|
39
44
|
* ```typescript
|
|
40
45
|
* const company = await client.companies.create({
|
|
41
|
-
* name: 'Acme Corp'
|
|
46
|
+
* name: 'Acme Corp',
|
|
47
|
+
* custom_attributes: { industry: 'Technology' }
|
|
42
48
|
* });
|
|
43
49
|
* console.log(company); // The created company
|
|
44
50
|
* ```
|
|
@@ -47,12 +53,12 @@ export declare class Companies extends BaseResource {
|
|
|
47
53
|
/**
|
|
48
54
|
* Get a company by ID
|
|
49
55
|
* @param companyId - The company ID to retrieve
|
|
50
|
-
* @returns The company
|
|
56
|
+
* @returns The company wrapped in payload
|
|
51
57
|
*
|
|
52
58
|
* @example
|
|
53
59
|
* ```typescript
|
|
54
|
-
* const
|
|
55
|
-
* console.log(
|
|
60
|
+
* const response = await client.companies.get(456);
|
|
61
|
+
* console.log(response.payload); // The company
|
|
56
62
|
* ```
|
|
57
63
|
*/
|
|
58
64
|
get(companyId: number): Promise<GetCompanyResponse>;
|
|
@@ -65,7 +71,8 @@ export declare class Companies extends BaseResource {
|
|
|
65
71
|
* @example
|
|
66
72
|
* ```typescript
|
|
67
73
|
* const company = await client.companies.update(456, {
|
|
68
|
-
* name: 'Acme Corp Updated'
|
|
74
|
+
* name: 'Acme Corp Updated',
|
|
75
|
+
* custom_attributes: { industry: 'Finance' }
|
|
69
76
|
* });
|
|
70
77
|
* console.log(company); // The updated company
|
|
71
78
|
* ```
|
|
@@ -100,7 +107,21 @@ export declare class Companies extends BaseResource {
|
|
|
100
107
|
* ```
|
|
101
108
|
*/
|
|
102
109
|
delete(companyId: number): Promise<void>;
|
|
110
|
+
/**
|
|
111
|
+
* List orders associated with a company
|
|
112
|
+
* @param companyId - The company ID
|
|
113
|
+
* @param params - Pagination parameters
|
|
114
|
+
* @returns List of orders with metadata
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* ```typescript
|
|
118
|
+
* const response = await client.companies.orders(456);
|
|
119
|
+
* console.log(response.payload); // Array of orders
|
|
120
|
+
* console.log(response.meta); // { count, current_page }
|
|
121
|
+
* ```
|
|
122
|
+
*/
|
|
123
|
+
orders(companyId: number, params?: CompanyOrdersParams): Promise<CompanyOrdersResponse>;
|
|
103
124
|
}
|
|
104
|
-
export type { Company, CreateCompanyParams, CreateCompanyRequest, CreateCompanyResponse, GetCompanyResponse, ListCompaniesParams, ListCompaniesResponse, SearchCompaniesParams, SearchCompaniesResponse, UpdateCompanyParams, UpdateCompanyRequest, UpdateCompanyResponse, } from "./types.js";
|
|
105
|
-
export { CompanySchema, CreateCompanyParamsSchema, CreateCompanyRequestSchema, CreateCompanyResponseSchema, GetCompanyResponseSchema, ListCompaniesParamsSchema, ListCompaniesResponseSchema, SearchCompaniesParamsSchema, SearchCompaniesResponseSchema, UpdateCompanyParamsSchema, UpdateCompanyRequestSchema, UpdateCompanyResponseSchema, } from "./types.js";
|
|
125
|
+
export type { Company, CompanyOrdersParams, CompanyOrdersResponse, CreateCompanyParams, CreateCompanyRequest, CreateCompanyResponse, GetCompanyResponse, ListCompaniesParams, ListCompaniesResponse, SearchCompaniesParams, SearchCompaniesResponse, UpdateCompanyParams, UpdateCompanyRequest, UpdateCompanyResponse, } from "./types.js";
|
|
126
|
+
export { CompanyOrdersParamsSchema, CompanyOrdersResponseSchema, CompanySchema, CreateCompanyParamsSchema, CreateCompanyRequestSchema, CreateCompanyResponseSchema, GetCompanyResponseSchema, ListCompaniesParamsSchema, ListCompaniesResponseSchema, SearchCompaniesParamsSchema, SearchCompaniesResponseSchema, UpdateCompanyParamsSchema, UpdateCompanyRequestSchema, UpdateCompanyResponseSchema, } from "./types.js";
|
|
106
127
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../resources/companies/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,qBAAa,SAAU,SAAQ,YAAY;IACzC;;OAEG;IACH,SAAgB,OAAO,EAAE,cAAc,CAAC;gBAE5B,MAAM,EAAE,UAAU;IAI9B
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../resources/companies/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,qBAAa,SAAU,SAAQ,YAAY;IACzC;;OAEG;IACH,SAAgB,OAAO,EAAE,cAAc,CAAC;gBAE5B,MAAM,EAAE,UAAU;IAI9B;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAMxE;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAMzE;;;;;;;;;;OAUG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIzD;;;;;;;;;;;;;;OAcG;IACG,MAAM,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,qBAAqB,CAAC;IAOjC;;;;;;;;;;;;;;OAcG;IACG,MAAM,CACV,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,uBAAuB,CAAC;IAMnC;;;;;;;;OAQG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9C;;;;;;;;;;;;OAYG;IACG,MAAM,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,mBAAmB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;CAMlC;AAGD,YAAY,EACV,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,aAAa,EACb,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,YAAY,CAAC"}
|
|
@@ -14,16 +14,21 @@ export class Companies extends BaseResource {
|
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* List all companies
|
|
17
|
-
* @param params - Pagination parameters
|
|
18
|
-
* @returns List of companies
|
|
17
|
+
* @param params - Pagination and filter parameters
|
|
18
|
+
* @returns List of companies with metadata
|
|
19
19
|
*
|
|
20
20
|
* @example
|
|
21
21
|
* ```typescript
|
|
22
|
-
* const
|
|
23
|
-
* console.log(
|
|
22
|
+
* const response = await client.companies.list();
|
|
23
|
+
* console.log(response.payload); // Array of companies
|
|
24
|
+
* console.log(response.meta); // { count, current_page }
|
|
24
25
|
*
|
|
25
|
-
* // With pagination
|
|
26
|
-
* const
|
|
26
|
+
* // With pagination and sorting
|
|
27
|
+
* const response = await client.companies.list({
|
|
28
|
+
* page: 2,
|
|
29
|
+
* per_page: 50,
|
|
30
|
+
* sort: '-updated_at'
|
|
31
|
+
* });
|
|
27
32
|
* ```
|
|
28
33
|
*/
|
|
29
34
|
async list(params) {
|
|
@@ -39,7 +44,8 @@ export class Companies extends BaseResource {
|
|
|
39
44
|
* @example
|
|
40
45
|
* ```typescript
|
|
41
46
|
* const company = await client.companies.create({
|
|
42
|
-
* name: 'Acme Corp'
|
|
47
|
+
* name: 'Acme Corp',
|
|
48
|
+
* custom_attributes: { industry: 'Technology' }
|
|
43
49
|
* });
|
|
44
50
|
* console.log(company); // The created company
|
|
45
51
|
* ```
|
|
@@ -52,12 +58,12 @@ export class Companies extends BaseResource {
|
|
|
52
58
|
/**
|
|
53
59
|
* Get a company by ID
|
|
54
60
|
* @param companyId - The company ID to retrieve
|
|
55
|
-
* @returns The company
|
|
61
|
+
* @returns The company wrapped in payload
|
|
56
62
|
*
|
|
57
63
|
* @example
|
|
58
64
|
* ```typescript
|
|
59
|
-
* const
|
|
60
|
-
* console.log(
|
|
65
|
+
* const response = await client.companies.get(456);
|
|
66
|
+
* console.log(response.payload); // The company
|
|
61
67
|
* ```
|
|
62
68
|
*/
|
|
63
69
|
async get(companyId) {
|
|
@@ -72,7 +78,8 @@ export class Companies extends BaseResource {
|
|
|
72
78
|
* @example
|
|
73
79
|
* ```typescript
|
|
74
80
|
* const company = await client.companies.update(456, {
|
|
75
|
-
* name: 'Acme Corp Updated'
|
|
81
|
+
* name: 'Acme Corp Updated',
|
|
82
|
+
* custom_attributes: { industry: 'Finance' }
|
|
76
83
|
* });
|
|
77
84
|
* console.log(company); // The updated company
|
|
78
85
|
* ```
|
|
@@ -112,7 +119,23 @@ export class Companies extends BaseResource {
|
|
|
112
119
|
async delete(companyId) {
|
|
113
120
|
await this.client.delete(`/companies/${companyId}`);
|
|
114
121
|
}
|
|
122
|
+
/**
|
|
123
|
+
* List orders associated with a company
|
|
124
|
+
* @param companyId - The company ID
|
|
125
|
+
* @param params - Pagination parameters
|
|
126
|
+
* @returns List of orders with metadata
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* ```typescript
|
|
130
|
+
* const response = await client.companies.orders(456);
|
|
131
|
+
* console.log(response.payload); // Array of orders
|
|
132
|
+
* console.log(response.meta); // { count, current_page }
|
|
133
|
+
* ```
|
|
134
|
+
*/
|
|
135
|
+
async orders(companyId, params) {
|
|
136
|
+
return await this.client.get(`/companies/${companyId}/orders`, { params });
|
|
137
|
+
}
|
|
115
138
|
}
|
|
116
139
|
// Re-export Zod schemas
|
|
117
|
-
export { CompanySchema, CreateCompanyParamsSchema, CreateCompanyRequestSchema, CreateCompanyResponseSchema, GetCompanyResponseSchema, ListCompaniesParamsSchema, ListCompaniesResponseSchema, SearchCompaniesParamsSchema, SearchCompaniesResponseSchema, UpdateCompanyParamsSchema, UpdateCompanyRequestSchema, UpdateCompanyResponseSchema, } from "./types.js";
|
|
140
|
+
export { CompanyOrdersParamsSchema, CompanyOrdersResponseSchema, CompanySchema, CreateCompanyParamsSchema, CreateCompanyRequestSchema, CreateCompanyResponseSchema, GetCompanyResponseSchema, ListCompaniesParamsSchema, ListCompaniesResponseSchema, SearchCompaniesParamsSchema, SearchCompaniesResponseSchema, UpdateCompanyParamsSchema, UpdateCompanyRequestSchema, UpdateCompanyResponseSchema, } from "./types.js";
|
|
118
141
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../resources/companies/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../resources/companies/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAc7D;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAY;IAMzC,YAAY,MAAkB;QAC5B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,OAAO,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,IAAI,CAAC,MAA4B;QACrC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAwB,YAAY,EAAE;YAChE,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CAAC,MAA2B;QACtC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAwB,YAAY,EAAE;YACjE,OAAO,EAAE,MAAM;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,SAAiB;QACzB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAqB,cAAc,SAAS,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CACV,SAAiB,EACjB,MAA2B;QAE3B,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,cAAc,SAAS,EAAE,EACzB,EAAE,OAAO,EAAE,MAAM,EAAE,CACpB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CACV,KAAa,EACb,MAA6C;QAE7C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAA0B,mBAAmB,EAAE;YACzE,MAAM,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CAAC,SAAiB;QAC5B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAO,cAAc,SAAS,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,MAAM,CACV,SAAiB,EACjB,MAA4B;QAE5B,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAC1B,cAAc,SAAS,SAAS,EAChC,EAAE,MAAM,EAAE,CACX,CAAC;IACJ,CAAC;CACF;AAoBD,wBAAwB;AACxB,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,aAAa,EACb,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,YAAY,CAAC"}
|