@arrowsphere/api-client 3.183.0 → 3.184.0-rc-bdj-2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,8 +2,11 @@ export * from './types/graphqlApiQueries';
2
2
  export * from './types/graphqlApiSchemas';
3
3
  export * from './types/entities/contact';
4
4
  export * from './types/entities/company';
5
+ export * from './types/entities/contributor';
5
6
  export * from './types/entities/country';
6
7
  export * from './types/entities/currency';
8
+ export * from './types/entities/disclaimer';
9
+ export * from './types/entities/eav';
7
10
  export * from './types/entities/licenseBudget';
8
11
  export * from './types/entities/order';
9
12
  export * from './types/entities/organizationUnit';
@@ -18,8 +18,11 @@ __exportStar(require("./types/graphqlApiQueries"), exports);
18
18
  __exportStar(require("./types/graphqlApiSchemas"), exports);
19
19
  __exportStar(require("./types/entities/contact"), exports);
20
20
  __exportStar(require("./types/entities/company"), exports);
21
+ __exportStar(require("./types/entities/contributor"), exports);
21
22
  __exportStar(require("./types/entities/country"), exports);
22
23
  __exportStar(require("./types/entities/currency"), exports);
24
+ __exportStar(require("./types/entities/disclaimer"), exports);
25
+ __exportStar(require("./types/entities/eav"), exports);
23
26
  __exportStar(require("./types/entities/licenseBudget"), exports);
24
27
  __exportStar(require("./types/entities/order"), exports);
25
28
  __exportStar(require("./types/entities/organizationUnit"), exports);
@@ -0,0 +1,17 @@
1
+ import { WorkgroupType } from './workgroup';
2
+ export declare type GraphqlApiContributorType = {
3
+ id?: number;
4
+ icst?: GraphqlApiStaffType;
5
+ isr?: GraphqlApiStaffType;
6
+ fcst?: GraphqlApiStaffType;
7
+ fsr?: GraphqlApiStaffType;
8
+ sor?: GraphqlApiStaffType;
9
+ };
10
+ export declare type GraphqlApiStaffType = {
11
+ id?: number;
12
+ firstname?: string;
13
+ internalId?: string;
14
+ lastname?: string;
15
+ locked?: boolean;
16
+ workgroup?: WorkgroupType;
17
+ };
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=contributor.js.map
@@ -0,0 +1,8 @@
1
+ import { GraphqlApiProgramType } from './program';
2
+ import { WorkgroupType } from './workgroup';
3
+ export declare type GraphqlApiDisclaimerType = {
4
+ id?: number;
5
+ content?: string;
6
+ program?: GraphqlApiProgramType;
7
+ workgroup?: WorkgroupType;
8
+ };
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=disclaimer.js.map
@@ -0,0 +1,7 @@
1
+ export declare type GraphqlApiEavType = {
2
+ id?: number;
3
+ name?: string;
4
+ resourceId?: number;
5
+ type?: string;
6
+ value?: string;
7
+ };
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=eav.js.map
@@ -1,12 +1,48 @@
1
+ import { ArrowCompanyType, EndCustomerType, PartnerType } from './company';
2
+ import { ContactsType } from './contact';
3
+ import { GraphqlApiContributorType } from './contributor';
4
+ import { GraphqlApiEavType } from './eav';
5
+ import { GraphqlApiProgramType } from './program';
6
+ import { ItemData, QuoteType } from './quote';
1
7
  import { SpecialPriceRateType } from './specialPriceRate';
2
8
  import { GraphqlApiUnitType } from './unit';
9
+ import { UserType } from './user';
3
10
  export declare type OrdersType = {
4
11
  id?: number;
12
+ arrowCompany?: ArrowCompanyType;
13
+ arrowContact?: ContactsType;
14
+ commitmentAmountTotal?: number;
15
+ contributor?: GraphqlApiContributorType;
16
+ createdAt?: string;
17
+ eavs?: GraphqlApiEavType[];
18
+ endCustomer?: EndCustomerType;
19
+ endCustomerContact?: ContactsType;
20
+ endCustomerPoNumber?: string;
21
+ fulfilledAt?: string;
5
22
  items?: OrderItemsType[];
23
+ partner?: PartnerType;
24
+ partnerContact?: ContactsType;
25
+ partnerPoNumber?: string;
26
+ poNumber?: string;
27
+ quote?: QuoteType;
28
+ reference?: string;
29
+ scheduledAt?: string;
30
+ status?: GraphqlApiOrderStatusType;
31
+ totalRecurringPrice?: number;
32
+ updatedAt?: string;
33
+ uuid?: number;
6
34
  };
7
35
  export declare type OrderItemsType = {
8
36
  id?: number;
37
+ itemData?: ItemData;
38
+ migratedFrom?: GraphqlApiOrderLinkType[];
39
+ migratedTo?: GraphqlApiOrderLinkType[];
40
+ name?: string;
41
+ order?: OrdersType;
9
42
  priceRates?: SpecialPriceRateType[];
43
+ program?: GraphqlApiProgramType;
44
+ reference?: string;
45
+ status?: GraphqlApiOrderStatusType;
10
46
  };
11
47
  export declare type GraphqlApiOrderSoftwareType = {
12
48
  id?: number;
@@ -14,3 +50,20 @@ export declare type GraphqlApiOrderSoftwareType = {
14
50
  totalAmount?: number;
15
51
  unit?: GraphqlApiUnitType;
16
52
  };
53
+ export declare type GraphqlApiOrderStatusType = {
54
+ id?: number;
55
+ name?: string;
56
+ };
57
+ export declare type GraphqlApiOrderLinkType = {
58
+ from?: OrderItemsType;
59
+ migratedAt?: string;
60
+ to?: OrderItemsType;
61
+ };
62
+ export declare type GraphqlApiOrderHistoryType = {
63
+ id?: number;
64
+ action?: string;
65
+ createdAt?: string;
66
+ description?: string;
67
+ order?: OrdersType;
68
+ user?: UserType;
69
+ };
@@ -1,18 +1,22 @@
1
1
  import { PartnerType } from './company';
2
+ import { GraphqlApiDisclaimerType } from './disclaimer';
2
3
  import { SubscriptionType } from './subscription';
3
4
  import { VendorsType } from './vendor';
4
5
  export declare type GraphqlApiProgramType = {
5
6
  id?: number;
6
7
  bypassReport?: number;
7
8
  description?: string;
9
+ disclaimer?: GraphqlApiDisclaimerType;
8
10
  internalName?: string;
9
11
  introduction?: string;
10
12
  levels?: ProgramLevelType[];
11
13
  name?: string;
12
14
  subscriptionExtraFields?: SubscriptionExtraFieldType[];
15
+ type?: GraphqlApiProgramTypeType;
13
16
  url?: string;
14
17
  vendor?: VendorsType;
15
- type?: GraphqlApiProgramTypeType;
18
+ vendorReference?: string;
19
+ xacVendorCode?: string;
16
20
  };
17
21
  export declare type GraphqlApiProgramTypeType = {
18
22
  id?: number;
@@ -2,6 +2,7 @@ import { ArrowCompanyType, EndCustomerType, PartnerType } from './entities/compa
2
2
  import { ContactsType } from './entities/contact';
3
3
  import { ContinentType, CountryType } from './entities/country';
4
4
  import { LicenseBudgetType } from './entities/licenseBudget';
5
+ import { GraphqlApiOrderHistoryType, OrdersType } from './entities/order';
5
6
  import { OrganizationUnitsType } from './entities/organizationUnit';
6
7
  import { PartnertagType } from './entities/partnertag';
7
8
  import { GraphqlApiProgramType, ProgramLevelOptionGroupType, SubscribedProgramType } from './entities/program';
@@ -123,6 +124,8 @@ export declare enum SelectDataField {
123
124
  END_CUSTOMER = "endCustomer",
124
125
  LICENSE_BUDGET = "licenseBudget",
125
126
  ORGANIZATION_UNIT = "organizationUnit",
127
+ ORDER = "order",
128
+ ORDER_HISTORY = "orderHistory",
126
129
  PARTNER = "partner",
127
130
  PARTNERTAG = "partnertag",
128
131
  PROGRAM = "program",
@@ -152,6 +155,8 @@ export declare type SelectAllResponseDataType = {
152
155
  [SelectDataField.END_CUSTOMER]?: EndCustomerType[];
153
156
  [SelectDataField.LICENSE_BUDGET]?: LicenseBudgetType[];
154
157
  [SelectDataField.ORGANIZATION_UNIT]?: OrganizationUnitsType[];
158
+ [SelectDataField.ORDER]?: OrdersType[];
159
+ [SelectDataField.ORDER_HISTORY]?: GraphqlApiOrderHistoryType[];
155
160
  [SelectDataField.PARTNER]?: PartnerType[];
156
161
  [SelectDataField.PARTNERTAG]?: PartnertagType[];
157
162
  [SelectDataField.PROGRAM]?: GraphqlApiProgramType[];
@@ -230,6 +235,8 @@ export declare type SelectOneResponseDataType = {
230
235
  [SelectDataField.END_CUSTOMER]?: EndCustomerType;
231
236
  [SelectDataField.LICENSE_BUDGET]?: LicenseBudgetType;
232
237
  [SelectDataField.ORGANIZATION_UNIT]?: OrganizationUnitsType;
238
+ [SelectDataField.ORDER]?: OrdersType;
239
+ [SelectDataField.ORDER_HISTORY]?: GraphqlApiOrderHistoryType;
233
240
  [SelectDataField.PARTNER]?: PartnerType;
234
241
  [SelectDataField.PARTNERTAG]?: PartnertagType;
235
242
  [SelectDataField.PROGRAM]?: GraphqlApiProgramType;
@@ -97,6 +97,8 @@ var SelectDataField;
97
97
  SelectDataField["END_CUSTOMER"] = "endCustomer";
98
98
  SelectDataField["LICENSE_BUDGET"] = "licenseBudget";
99
99
  SelectDataField["ORGANIZATION_UNIT"] = "organizationUnit";
100
+ SelectDataField["ORDER"] = "order";
101
+ SelectDataField["ORDER_HISTORY"] = "orderHistory";
100
102
  SelectDataField["PARTNER"] = "partner";
101
103
  SelectDataField["PARTNERTAG"] = "partnertag";
102
104
  SelectDataField["PROGRAM"] = "program";
@@ -7,7 +7,7 @@ import { ErrorsType, PageType, Queries, SelectDataField, SelectableField } from
7
7
  import { ContactsType } from './entities/contact';
8
8
  import { SubscriptionType } from './entities/subscription';
9
9
  import { SpecialPriceRateType } from './entities/specialPriceRate';
10
- import { OrderItemsType, OrdersType } from './entities/order';
10
+ import { GraphqlApiOrderHistoryType, GraphqlApiOrderLinkType, OrderItemsType, OrdersType } from './entities/order';
11
11
  import { GraphqlApiProgramType, ProgramBenefitType, ProgramLevelType, ProgramRequirementType, ProgramLevelOptionGroupType, ProgramLevelOptionType, SubscribedProgramType, SubscriptionExtraFieldType } from './entities/program';
12
12
  import { LicenseBudgetNotificationType, LicenseBudgetType } from './entities/licenseBudget';
13
13
  import { UserHistoryType, UserType } from './entities/user';
@@ -17,6 +17,7 @@ import { ItemData, QuoteItemType, QuoteType } from './entities/quote';
17
17
  import { QuoteVersion } from './entities/quoteVersion';
18
18
  import { Comment } from './entities/comment';
19
19
  import { GraphqlApiReportItemType, GraphqlApiReportStatusType, GraphqlApiReportType } from './entities/report';
20
+ import { GraphqlApiEavType } from './entities/eav';
20
21
  export declare type PartnertagSchema = Schema<PartnertagType, boolean>;
21
22
  declare type MissingFieldsOfCompanySchema = {
22
23
  contacts?: ContactsSchema;
@@ -42,9 +43,12 @@ declare type MissingFieldsOfEndCustomerSchema = {
42
43
  country?: CountrySchema;
43
44
  };
44
45
  declare type MissingFieldsOfOrderItemSchema = {
46
+ migratedFrom?: GraphqlApiOrderLinkSchema;
47
+ migratedTo?: GraphqlApiOrderLinkSchema;
45
48
  priceRates?: SpecialPriceRateSchema;
46
49
  };
47
50
  declare type MissingFieldsOfOrdersSchema = {
51
+ eavs?: GraphqlApiEavSchema;
48
52
  items?: OrderItemsSchema;
49
53
  };
50
54
  declare type MissingFieldsOfContactSchema = {
@@ -101,6 +105,9 @@ export declare type ContinentSchema = Schema<ContinentType, boolean>;
101
105
  export declare type CountrySchema = Merge<Schema<CountryType, boolean>, MissingFieldsOfCountrySchema>;
102
106
  export declare type CurrencySchema = Schema<CurrencyType, boolean>;
103
107
  export declare type ErrorsSchema = Schema<ErrorsType, boolean>;
108
+ export declare type GraphqlApiEavSchema = Schema<GraphqlApiEavType, boolean>;
109
+ export declare type GraphqlApiOrderHistorySchema = Schema<GraphqlApiOrderHistoryType, boolean>;
110
+ export declare type GraphqlApiOrderLinkSchema = Schema<GraphqlApiOrderLinkType, boolean>;
104
111
  export declare type LicenseBudgetNotificationSchema = Schema<LicenseBudgetNotificationType, boolean>;
105
112
  export declare type BaseCompanySchema = Schema<BaseCompanyType, boolean>;
106
113
  export declare type OrganizationUnitSchema = Schema<OrganizationUnitsType, boolean>;
@@ -143,6 +150,8 @@ export declare type SelectAllResponseDataSchema = {
143
150
  [SelectDataField.END_CUSTOMER]?: EndCustomerSchema;
144
151
  [SelectDataField.LICENSE_BUDGET]?: LicenseBudgetSchema;
145
152
  [SelectDataField.ORGANIZATION_UNIT]?: OrganizationUnitSchema;
153
+ [SelectDataField.ORDER]?: OrdersSchema;
154
+ [SelectDataField.ORDER_HISTORY]?: GraphqlApiOrderHistoryType;
146
155
  [SelectDataField.PARTNER]?: PartnerSchema;
147
156
  [SelectDataField.PARTNERTAG]?: PartnertagSchema;
148
157
  [SelectDataField.PROGRAM]?: GraphqlApiProgramSchema;
@@ -1,5 +1,6 @@
1
1
  export * from './entities/dataListOrders';
2
2
  export * from './entities/orders/order';
3
+ export * from './entities/orders/updateOrderResult';
3
4
  export * from './entities/orders/partner/partner';
4
5
  export * from './entities/orders/products/identifiers/vendor/identifiersVendor';
5
6
  export * from './entities/orders/products/identifiers/productIdentifiers';
@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./entities/dataListOrders"), exports);
18
18
  __exportStar(require("./entities/orders/order"), exports);
19
+ __exportStar(require("./entities/orders/updateOrderResult"), exports);
19
20
  __exportStar(require("./entities/orders/partner/partner"), exports);
20
21
  __exportStar(require("./entities/orders/products/identifiers/vendor/identifiersVendor"), exports);
21
22
  __exportStar(require("./entities/orders/products/identifiers/productIdentifiers"), exports);
@@ -129,6 +129,14 @@ export declare type UpdateOrderInputType = {
129
129
  [UpdateOrderInputFields.COLUMN_PO_NUMBER]: string;
130
130
  [UpdateOrderInputFields.COLUMN_END_CUSTOMER_PO_NUMBER]: string;
131
131
  };
132
+ export declare enum UpdateContributorOrderInputFields {
133
+ COLUMN_TYPE = "type",
134
+ COLUMN_CONTRIBUTOR_ID = "contributorId"
135
+ }
136
+ export declare type UpdateContributorOrderInputType = {
137
+ [UpdateContributorOrderInputFields.COLUMN_TYPE]: string;
138
+ [UpdateContributorOrderInputFields.COLUMN_CONTRIBUTOR_ID]?: string;
139
+ };
132
140
  export declare class OrdersClient extends AbstractRestfulClient {
133
141
  /**
134
142
  * The base path of the API
@@ -138,4 +146,10 @@ export declare class OrdersClient extends AbstractRestfulClient {
138
146
  getListOrders(perPage?: number, page?: number, parameters?: Parameters): Promise<GetResult<DataListOrders>>;
139
147
  getOrder(orderReference: string, parameters?: Parameters): Promise<GetResult<DataListOrders>>;
140
148
  updateOrder(orderReference: string, payload: UpdateOrderInputType, parameters?: Parameters): Promise<GetResult<UpdateOrderResult>>;
149
+ archiveOrder(orderReference: string, parameters?: Parameters): Promise<void>;
150
+ cancelOrder(orderReference: string, parameters?: Parameters): Promise<void>;
151
+ rejectGradedOrder(orderReference: string, parameters?: Parameters): Promise<void>;
152
+ resubmitOrder(orderReference: string, parameters?: Parameters): Promise<void>;
153
+ validateOrder(orderReference: string, parameters?: Parameters): Promise<void>;
154
+ updateStaffContributorsOrder(orderReference: string, payload: UpdateContributorOrderInputType, parameters?: Parameters): Promise<void>;
141
155
  }
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OrdersClient = exports.UpdateOrderInputFields = exports.scenarioType = exports.CreateOrderInputFields = void 0;
3
+ exports.OrdersClient = exports.UpdateContributorOrderInputFields = exports.UpdateOrderInputFields = exports.scenarioType = exports.CreateOrderInputFields = void 0;
4
4
  const abstractRestfulClient_1 = require("../abstractRestfulClient");
5
5
  const getResult_1 = require("../getResult");
6
6
  const dataListOrders_1 = require("./entities/dataListOrders");
@@ -60,6 +60,11 @@ var UpdateOrderInputFields;
60
60
  UpdateOrderInputFields["COLUMN_PO_NUMBER"] = "PO_number";
61
61
  UpdateOrderInputFields["COLUMN_END_CUSTOMER_PO_NUMBER"] = "end_customer_PO_number";
62
62
  })(UpdateOrderInputFields = exports.UpdateOrderInputFields || (exports.UpdateOrderInputFields = {}));
63
+ var UpdateContributorOrderInputFields;
64
+ (function (UpdateContributorOrderInputFields) {
65
+ UpdateContributorOrderInputFields["COLUMN_TYPE"] = "type";
66
+ UpdateContributorOrderInputFields["COLUMN_CONTRIBUTOR_ID"] = "contributorId";
67
+ })(UpdateContributorOrderInputFields = exports.UpdateContributorOrderInputFields || (exports.UpdateContributorOrderInputFields = {}));
63
68
  class OrdersClient extends abstractRestfulClient_1.AbstractRestfulClient {
64
69
  constructor() {
65
70
  super(...arguments);
@@ -84,6 +89,30 @@ class OrdersClient extends abstractRestfulClient_1.AbstractRestfulClient {
84
89
  this.path = `/${orderReference}`;
85
90
  return new getResult_1.GetResult(updateOrderResult_1.UpdateOrderResult, await this.patch(payload, parameters));
86
91
  }
92
+ async archiveOrder(orderReference, parameters = {}) {
93
+ this.path = `/${orderReference}/archive`;
94
+ await this.patch(undefined, parameters);
95
+ }
96
+ async cancelOrder(orderReference, parameters = {}) {
97
+ this.path = `/${orderReference}/cancel`;
98
+ await this.patch(undefined, parameters);
99
+ }
100
+ async rejectGradedOrder(orderReference, parameters = {}) {
101
+ this.path = `/${orderReference}/rejectGraded`;
102
+ await this.patch(undefined, parameters);
103
+ }
104
+ async resubmitOrder(orderReference, parameters = {}) {
105
+ this.path = `/${orderReference}/resubmit`;
106
+ await this.patch(undefined, parameters);
107
+ }
108
+ async validateOrder(orderReference, parameters = {}) {
109
+ this.path = `/${orderReference}/validate`;
110
+ await this.patch(undefined, parameters);
111
+ }
112
+ async updateStaffContributorsOrder(orderReference, payload, parameters = {}) {
113
+ this.path = `/${orderReference}/contributor`;
114
+ await this.patch(payload, parameters);
115
+ }
87
116
  }
88
117
  exports.OrdersClient = OrdersClient;
89
118
  //# sourceMappingURL=ordersClient.js.map
@@ -22,5 +22,6 @@ export declare enum OrderStatusEnum {
22
22
  SEND = "Sent",
23
23
  ORDER_VALIDATED = "Order Validated",
24
24
  SCHEDULED_ORDER = "Scheduled Order",
25
- CANCELED = "Canceled"
25
+ CANCELED = "Canceled",
26
+ PENDING_FINANCE_VALIDATION = "Pending Finance validation"
26
27
  }
@@ -27,5 +27,6 @@ var OrderStatusEnum;
27
27
  OrderStatusEnum["ORDER_VALIDATED"] = "Order Validated";
28
28
  OrderStatusEnum["SCHEDULED_ORDER"] = "Scheduled Order";
29
29
  OrderStatusEnum["CANCELED"] = "Canceled";
30
+ OrderStatusEnum["PENDING_FINANCE_VALIDATION"] = "Pending Finance validation";
30
31
  })(OrderStatusEnum = exports.OrderStatusEnum || (exports.OrderStatusEnum = {}));
31
32
  //# sourceMappingURL=orderStatus.js.map
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "type": "git",
5
5
  "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
6
6
  },
7
- "version": "3.183.0",
7
+ "version": "3.184.0-rc-bdj-2",
8
8
  "description": "Node.js client for ArrowSphere's public API",
9
9
  "main": "build/index.js",
10
10
  "types": "build/index.d.ts",