@or-sdk/ccp 1.2.3 → 1.2.4-beta.3121.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.
Files changed (62) hide show
  1. package/dist/cjs/Ccp.js +1 -0
  2. package/dist/cjs/Ccp.js.map +1 -1
  3. package/dist/cjs/api/customers-api/constants.js +28 -0
  4. package/dist/cjs/api/customers-api/constants.js.map +1 -0
  5. package/dist/cjs/api/{customersApi.js → customers-api/customersApi.js} +59 -1
  6. package/dist/cjs/api/customers-api/customersApi.js.map +1 -0
  7. package/dist/cjs/api/customers-api/types.js +3 -0
  8. package/dist/cjs/api/customers-api/types.js.map +1 -0
  9. package/dist/cjs/api/index.js +4 -2
  10. package/dist/cjs/api/index.js.map +1 -1
  11. package/dist/cjs/api/providersApi.js +149 -0
  12. package/dist/cjs/api/providersApi.js.map +1 -0
  13. package/dist/cjs/constants.js +6 -1
  14. package/dist/cjs/constants.js.map +1 -1
  15. package/dist/cjs/types.js +0 -9
  16. package/dist/cjs/types.js.map +1 -1
  17. package/dist/esm/Ccp.js +2 -1
  18. package/dist/esm/Ccp.js.map +1 -1
  19. package/dist/esm/api/customers-api/constants.js +25 -0
  20. package/dist/esm/api/customers-api/constants.js.map +1 -0
  21. package/dist/esm/api/{customersApi.js → customers-api/customersApi.js} +38 -1
  22. package/dist/esm/api/customers-api/customersApi.js.map +1 -0
  23. package/dist/esm/api/customers-api/types.js +2 -0
  24. package/dist/esm/api/customers-api/types.js.map +1 -0
  25. package/dist/esm/api/index.js +2 -1
  26. package/dist/esm/api/index.js.map +1 -1
  27. package/dist/esm/api/providersApi.js +71 -0
  28. package/dist/esm/api/providersApi.js.map +1 -0
  29. package/dist/esm/constants.js +5 -0
  30. package/dist/esm/constants.js.map +1 -1
  31. package/dist/esm/types.js +1 -8
  32. package/dist/esm/types.js.map +1 -1
  33. package/dist/types/Ccp.d.ts +2 -1
  34. package/dist/types/Ccp.d.ts.map +1 -1
  35. package/dist/types/api/customers-api/constants.d.ts +21 -0
  36. package/dist/types/api/customers-api/constants.d.ts.map +1 -0
  37. package/dist/types/api/customers-api/customersApi.d.ts +13 -0
  38. package/dist/types/api/customers-api/customersApi.d.ts.map +1 -0
  39. package/dist/types/api/customers-api/types.d.ts +82 -0
  40. package/dist/types/api/customers-api/types.d.ts.map +1 -0
  41. package/dist/types/api/index.d.ts +2 -1
  42. package/dist/types/api/index.d.ts.map +1 -1
  43. package/dist/types/api/providersApi.d.ts +12 -0
  44. package/dist/types/api/providersApi.d.ts.map +1 -0
  45. package/dist/types/constants.d.ts +4 -0
  46. package/dist/types/constants.d.ts.map +1 -1
  47. package/dist/types/types.d.ts +25 -26
  48. package/dist/types/types.d.ts.map +1 -1
  49. package/package.json +2 -3
  50. package/src/Ccp.ts +3 -0
  51. package/src/api/customers-api/constants.ts +23 -0
  52. package/src/api/customers-api/customersApi.ts +78 -0
  53. package/src/api/customers-api/types.ts +93 -0
  54. package/src/api/index.ts +2 -1
  55. package/src/api/providersApi.ts +83 -0
  56. package/src/constants.ts +5 -0
  57. package/src/types.ts +30 -28
  58. package/dist/cjs/api/customersApi.js.map +0 -1
  59. package/dist/esm/api/customersApi.js.map +0 -1
  60. package/dist/types/api/customersApi.d.ts +0 -8
  61. package/dist/types/api/customersApi.d.ts.map +0 -1
  62. package/src/api/customersApi.ts +0 -26
@@ -1 +1 @@
1
- {"version":3,"file":"Ccp.d.ts","sourceRoot":"","sources":["../../src/Ccp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE9D,OAAO,EACL,YAAY,EACZ,eAAe,EACf,WAAW,EACX,aAAa,EACb,UAAU,EACV,QAAQ,EACR,YAAY,EACb,MAAM,OAAO,CAAC;AAGf,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AASpC,qBAAa,GAAI,SAAQ,IAAI;IAC3B,SAAgB,YAAY,EAAE,YAAY,CAAC;IAC3C,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,SAAgB,WAAW,EAAE,WAAW,CAAC;IACzC,SAAgB,aAAa,EAAE,aAAa,CAAC;IAC7C,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,YAAY,EAAE,YAAY,CAAC;IAC3C,OAAO,CAAC,eAAe,CAAU;gBAQrB,MAAM,EAAE,SAAS;IAuB7B,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC;IAI5C,UAAU,CAAC,CAAC,EAAE,UAAU,GAAG,KAAK;IAahC,OAAO,CAAC,WAAW;CAYpB"}
1
+ {"version":3,"file":"Ccp.d.ts","sourceRoot":"","sources":["../../src/Ccp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE9D,OAAO,EACL,YAAY,EACZ,eAAe,EACf,WAAW,EACX,aAAa,EACb,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,YAAY,EACb,MAAM,OAAO,CAAC;AAGf,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AASpC,qBAAa,GAAI,SAAQ,IAAI;IAC3B,SAAgB,YAAY,EAAE,YAAY,CAAC;IAC3C,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,SAAgB,WAAW,EAAE,WAAW,CAAC;IACzC,SAAgB,aAAa,EAAE,aAAa,CAAC;IAC7C,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,YAAY,EAAE,YAAY,CAAC;IAC3C,SAAgB,YAAY,EAAE,YAAY,CAAC;IAC3C,OAAO,CAAC,eAAe,CAAU;gBAQrB,MAAM,EAAE,SAAS;IAwB7B,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC;IAI5C,UAAU,CAAC,CAAC,EAAE,UAAU,GAAG,KAAK;IAahC,OAAO,CAAC,WAAW;CAYpB"}
@@ -0,0 +1,21 @@
1
+ export declare enum CustomerStatus {
2
+ ACTIVE = "active",
3
+ INACTIVE = "inactive",
4
+ SUSPENDED = "suspended",
5
+ DELETED = "deleted",
6
+ TRIAL = "trial"
7
+ }
8
+ export declare enum ExtendedCustomerStatuses {
9
+ active = "active",
10
+ inactive = "inactive",
11
+ suspended = "suspended",
12
+ deleted = "DELETED"
13
+ }
14
+ export declare enum ExtendedCustomerPaymentStrategies {
15
+ postpayment = "postpayment"
16
+ }
17
+ export declare enum ExtendedCustomerInvoicingStatuses {
18
+ qa = "qa",
19
+ live = "live"
20
+ }
21
+ //# sourceMappingURL=constants.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/api/customers-api/constants.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACxB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,oBAAY,wBAAwB;IAClC,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,OAAO,YAAY;CACpB;AAED,oBAAY,iCAAiC;IAC3C,WAAW,gBAAgB;CAC5B;AAED,oBAAY,iCAAiC;IAC3C,EAAE,OAAO;IACT,IAAI,SAAS;CACd"}
@@ -0,0 +1,13 @@
1
+ import { PaginatedResponse } from '../../types';
2
+ import { BaseApi } from '../baseApi';
3
+ import { CreateExtendedCustomerParams, Customer, ExtendedCustomer, GetExtendedCustomersParams, UpdateExtendedCustomerParams } from './types';
4
+ export default class CustomersApi extends BaseApi {
5
+ private readonly apiBasePath;
6
+ currentCustomer(): Promise<Customer>;
7
+ listOfCustomers(): Promise<Customer[]>;
8
+ getExtendedCustomers(params?: GetExtendedCustomersParams): Promise<PaginatedResponse<ExtendedCustomer>>;
9
+ updateExtendedCustomer(id: string, data: UpdateExtendedCustomerParams): Promise<ExtendedCustomer>;
10
+ createExtendedCustomer(data: CreateExtendedCustomerParams): Promise<ExtendedCustomer>;
11
+ deleteExtendedCustomer(id: string): Promise<void>;
12
+ }
13
+ //# sourceMappingURL=customersApi.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"customersApi.d.ts","sourceRoot":"","sources":["../../../../src/api/customers-api/customersApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,4BAA4B,EAAE,QAAQ,EAAE,gBAAgB,EAAE,0BAA0B,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAE7I,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,OAAO;IAC/C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAKrC,eAAe,IAAI,OAAO,CAAC,QAAQ,CAAC;IAUpC,eAAe,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAW7C,oBAAoB,CAAC,MAAM,GAAE,0BAA+B,GAAG,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IAa3G,sBAAsB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAajG,sBAAsB,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYrF,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOxD"}
@@ -0,0 +1,82 @@
1
+ import { Pagination } from '../../types';
2
+ import { CustomerStatus, ExtendedCustomerInvoicingStatuses, ExtendedCustomerPaymentStrategies, ExtendedCustomerStatuses } from './constants';
3
+ export interface CustomerBillingAddress {
4
+ billingEmail: string[];
5
+ billingContactName?: string;
6
+ billingPhoneNumber?: string;
7
+ country?: string;
8
+ state?: string;
9
+ city?: string;
10
+ streetAddress?: string;
11
+ zipCode?: string | number;
12
+ }
13
+ export interface Customer {
14
+ Id: string;
15
+ Name: string;
16
+ Status: CustomerStatus;
17
+ Billable?: boolean;
18
+ BillingAddress?: CustomerBillingAddress;
19
+ IdwCustomerId?: string;
20
+ }
21
+ export type GetExtendedCustomersParams = {
22
+ id?: string;
23
+ name?: string;
24
+ billable?: boolean;
25
+ chargeCreditCard?: boolean;
26
+ domains?: string[];
27
+ approver?: string[];
28
+ managerId?: string;
29
+ parentCustomer?: string;
30
+ idwCustomerId?: string;
31
+ status?: ExtendedCustomerStatuses;
32
+ paymentStrategy?: ExtendedCustomerPaymentStrategies;
33
+ invoicingStatus?: ExtendedCustomerInvoicingStatuses;
34
+ stripeCustomerId?: string;
35
+ paymentProviderId?: string;
36
+ } & Pagination;
37
+ export type MappedProvider = {
38
+ id: string;
39
+ name: string;
40
+ providerKeys?: string[];
41
+ };
42
+ export type ExtendedCustomer = {
43
+ aNCustomerId?: string;
44
+ approverIds?: string[];
45
+ billable?: boolean;
46
+ billingAddress?: CustomerBillingAddress;
47
+ chargeCreditCard?: boolean;
48
+ created?: string;
49
+ customerProfileId?: string;
50
+ deliverInvoiceEmail?: boolean;
51
+ deliverInvoiceMail?: boolean;
52
+ domains?: string[];
53
+ endDate?: string;
54
+ friendlyName?: string;
55
+ id: string;
56
+ idwCustomerId?: string;
57
+ invoicingStatus?: ExtendedCustomerInvoicingStatuses;
58
+ managerId?: string;
59
+ name?: string;
60
+ parentCustomer?: string;
61
+ paymentProfileId?: string;
62
+ paymentStrategy?: ExtendedCustomerPaymentStrategies;
63
+ pageId?: string;
64
+ shortcode?: string;
65
+ slackChannel?: string;
66
+ startDate?: string;
67
+ status?: ExtendedCustomerStatuses;
68
+ stripeCustomerId?: string;
69
+ type?: string;
70
+ sendInvoiceCsv?: boolean;
71
+ providers?: MappedProvider[];
72
+ paymentProviderId?: string;
73
+ };
74
+ type UpdateMappedProvider = Omit<MappedProvider, 'name'> & {
75
+ name?: string;
76
+ };
77
+ export type CreateExtendedCustomerParams = Omit<Customer, 'id' | 'providers'> & {
78
+ providers?: UpdateMappedProvider[];
79
+ };
80
+ export type UpdateExtendedCustomerParams = CreateExtendedCustomerParams;
81
+ export {};
82
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api/customers-api/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EACL,cAAc,EACd,iCAAiC,EACjC,iCAAiC,EACjC,wBAAwB,EACzB,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,cAAc,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAClC,eAAe,CAAC,EAAE,iCAAiC,CAAC;IACpD,eAAe,CAAC,EAAE,iCAAiC,CAAC;IACpD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,GAAG,UAAU,CAAC;AAEf,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAGF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,iCAAiC,CAAC;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,iCAAiC,CAAC;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,KAAK,oBAAoB,GAAG,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;CAAE,CAAC;AAE9E,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,GAAG,WAAW,CAAC,GAAG;IAC9E,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,4BAA4B,CAAC"}
@@ -1,8 +1,9 @@
1
- export { default as CustomersApi } from './customersApi';
1
+ export { default as CustomersApi } from './customers-api/customersApi';
2
2
  export { default as EnvironmentsApi } from './environmentsApi';
3
3
  export { default as AccountsApi } from './accountsApi';
4
4
  export { default as CategoriesApi } from './categoriesApi';
5
5
  export { default as MappingApi } from './mappingApi';
6
6
  export { default as FlowsApi } from './flowsApi';
7
7
  export { default as ReportingApi } from './reportingApi';
8
+ export { default as ProvidersApi } from './reportingApi';
8
9
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}
@@ -0,0 +1,12 @@
1
+ import { ListPaymentProviderParams, PaymentProvider, Provider } from '../types';
2
+ import { BaseApi } from './baseApi';
3
+ export default class ProvidersApi extends BaseApi {
4
+ private readonly apiBasePath;
5
+ listProviders(id?: string): Promise<Provider[]>;
6
+ createProvider(name: string): Promise<Provider>;
7
+ deleteProvider(id: string): Promise<void>;
8
+ listPaymentProviders(params?: ListPaymentProviderParams): Promise<PaymentProvider[]>;
9
+ createPaymentProvider(name: string): Promise<PaymentProvider>;
10
+ deletePaymentProvider(id: string): Promise<void>;
11
+ }
12
+ //# sourceMappingURL=providersApi.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"providersApi.d.ts","sourceRoot":"","sources":["../../../src/api/providersApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEhF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,OAAO;IAC/C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAO5C,aAAa,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAa/C,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAY/C,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAazC,oBAAoB,CAAC,MAAM,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAapF,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAY7D,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOvD"}
@@ -1,2 +1,6 @@
1
1
  export declare const SERVICE_KEY = "customer-portal-api";
2
+ export declare enum OrderDirection {
3
+ ASC = "ASC",
4
+ DESC = "DESC"
5
+ }
2
6
  //# sourceMappingURL=constants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,wBAAwB,CAAC"}
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,wBAAwB,CAAC;AAEjD,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd"}
@@ -1,4 +1,4 @@
1
- import { Token } from '@or-sdk/base';
1
+ import { OrderDirection, Token } from '@or-sdk/base';
2
2
  export type CcpConfig = {
3
3
  token: Token;
4
4
  discoveryUrl?: string;
@@ -9,31 +9,6 @@ export type CcpConfig = {
9
9
  export type OptionalParams = {
10
10
  signal?: AbortSignal;
11
11
  };
12
- export declare enum CustomerStatus {
13
- ACTIVE = "active",
14
- INACTIVE = "inactive",
15
- SUSPENDED = "suspended",
16
- DELETED = "deleted",
17
- TRIAL = "trial"
18
- }
19
- export interface CustomerBillingAddress {
20
- billingEmail: string[];
21
- billingContactName?: string;
22
- billingPhoneNumber?: string;
23
- country?: string;
24
- state?: string;
25
- city?: string;
26
- streetAddress?: string;
27
- zipCode?: string | number;
28
- }
29
- export interface Customer {
30
- Id: string;
31
- Name: string;
32
- Status: CustomerStatus;
33
- Billable?: boolean;
34
- BillingAddress?: CustomerBillingAddress;
35
- IdwCustomerId?: string;
36
- }
37
12
  export type ApiRequestParams = {
38
13
  clientId: string;
39
14
  };
@@ -105,4 +80,28 @@ export interface Usage {
105
80
  environment_id: string;
106
81
  flow_id: string;
107
82
  }
83
+ export type ListPaymentProviderParams = {
84
+ id?: string;
85
+ name?: string;
86
+ };
87
+ export type PaymentProvider = {
88
+ id: string;
89
+ name: string;
90
+ };
91
+ export type Provider = {
92
+ id: string;
93
+ name: string;
94
+ };
95
+ export type PaginatedResponse<T> = {
96
+ data: T[];
97
+ total: number;
98
+ limit: number;
99
+ page: number;
100
+ };
101
+ export type Pagination = {
102
+ page?: number;
103
+ pageSize?: number;
104
+ orderDirection?: OrderDirection;
105
+ orderBy?: string;
106
+ };
108
107
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,SAAS,GAAG;IAItB,KAAK,EAAE,KAAK,CAAC;IAIb,YAAY,CAAC,EAAE,MAAM,CAAC;IAItB,SAAS,CAAC,EAAE,MAAM,CAAC;IAInB,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,oBAAY,cAAc;IACxB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,cAAc,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,YAAY,CAAC;AAExD,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG;IACxD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,CAAC;AAElD,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,OAAO;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;CAC3C;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG;IAClD,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE,IAAI,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErD,MAAM,MAAM,SAAS,GAAG;IAItB,KAAK,EAAE,KAAK,CAAC;IAIb,YAAY,CAAC,EAAE,MAAM,CAAC;IAItB,SAAS,CAAC,EAAE,MAAM,CAAC;IAInB,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,YAAY,CAAC;AAExD,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG;IACxD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,CAAC;AAElD,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,OAAO;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;CAC3C;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG;IAClD,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE,IAAI,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/ccp",
3
- "version": "1.2.3",
3
+ "version": "1.2.4-beta.3121.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -26,6 +26,5 @@
26
26
  },
27
27
  "publishConfig": {
28
28
  "access": "public"
29
- },
30
- "gitHead": "9683c4024545f5ac117311f4805d2153dbd17f50"
29
+ }
31
30
  }
package/src/Ccp.ts CHANGED
@@ -8,6 +8,7 @@ import {
8
8
  MappingApi,
9
9
  FlowsApi,
10
10
  ReportingApi,
11
+ ProvidersApi,
11
12
  } from './api';
12
13
  import { ApiError } from './apiError';
13
14
  import { SERVICE_KEY } from './constants';
@@ -28,6 +29,7 @@ export class Ccp extends Base {
28
29
  public readonly mappingApi: MappingApi;
29
30
  public readonly flowsApi: FlowsApi;
30
31
  public readonly reportingApi: ReportingApi;
32
+ public readonly providersApi: ProvidersApi;
31
33
  private withApiErrorLog: boolean;
32
34
 
33
35
  /**
@@ -57,6 +59,7 @@ export class Ccp extends Base {
57
59
  this.mappingApi = new MappingApi(apiCall);
58
60
  this.flowsApi = new FlowsApi(apiCall);
59
61
  this.reportingApi = new ReportingApi(apiCall);
62
+ this.providersApi = new ProvidersApi(apiCall);
60
63
  }
61
64
 
62
65
  callApi<T>(params: CalApiParams): Promise<T> {
@@ -0,0 +1,23 @@
1
+ export enum CustomerStatus {
2
+ ACTIVE = 'active',
3
+ INACTIVE = 'inactive',
4
+ SUSPENDED = 'suspended',
5
+ DELETED = 'deleted',
6
+ TRIAL = 'trial',
7
+ }
8
+
9
+ export enum ExtendedCustomerStatuses {
10
+ active = 'active',
11
+ inactive = 'inactive',
12
+ suspended = 'suspended',
13
+ deleted = 'DELETED',
14
+ }
15
+
16
+ export enum ExtendedCustomerPaymentStrategies {
17
+ postpayment = 'postpayment',
18
+ }
19
+
20
+ export enum ExtendedCustomerInvoicingStatuses {
21
+ qa = 'qa',
22
+ live = 'live',
23
+ }
@@ -0,0 +1,78 @@
1
+ import { PaginatedResponse } from '../../types';
2
+ import { BaseApi } from '../baseApi';
3
+
4
+ import { CreateExtendedCustomerParams, Customer, ExtendedCustomer, GetExtendedCustomersParams, UpdateExtendedCustomerParams } from './types';
5
+
6
+ export default class CustomersApi extends BaseApi {
7
+ private readonly apiBasePath = 'api/v1/customers';
8
+
9
+ /**
10
+ * @description get current customer
11
+ */
12
+ public async currentCustomer(): Promise<Customer> {
13
+ return await this.apiCall({
14
+ method: 'GET',
15
+ route: `${this.apiBasePath}`,
16
+ });
17
+ }
18
+
19
+ /**
20
+ * @description get all customers list
21
+ */
22
+ public async listOfCustomers(): Promise<Customer[]> {
23
+ return await this.apiCall({
24
+ method: 'GET',
25
+ route: `${this.apiBasePath}/list`,
26
+ });
27
+ }
28
+
29
+ /**
30
+ * Get paginated list of extended customers
31
+ * @param params Query parameters for filtering and pagination
32
+ */
33
+ async getExtendedCustomers(params: GetExtendedCustomersParams = {}): Promise<PaginatedResponse<ExtendedCustomer>> {
34
+ return await this.apiCall({
35
+ method: 'GET',
36
+ route: `${this.apiBasePath}/extended`,
37
+ params,
38
+ });
39
+ }
40
+
41
+ /**
42
+ * Update extended customer
43
+ * @param id Customer ID
44
+ * @param data Updated customer data
45
+ */
46
+ async updateExtendedCustomer(id: string, data: UpdateExtendedCustomerParams): Promise<ExtendedCustomer> {
47
+ return await this.apiCall({
48
+ method: 'PUT',
49
+ route: `${this.apiBasePath}/extended`,
50
+ params: { id },
51
+ data,
52
+ });
53
+ }
54
+
55
+ /**
56
+ * Create extended customer
57
+ * @param data Customer data
58
+ */
59
+ async createExtendedCustomer(data: CreateExtendedCustomerParams): Promise<ExtendedCustomer> {
60
+ return await this.apiCall({
61
+ method: 'POST',
62
+ route: `${this.apiBasePath}/extended`,
63
+ data,
64
+ });
65
+ }
66
+
67
+ /**
68
+ * Delete extended customer
69
+ * @param id Customer ID
70
+ */
71
+ async deleteExtendedCustomer(id: string): Promise<void> {
72
+ return await this.apiCall({
73
+ method: 'DELETE',
74
+ route: `${this.apiBasePath}/extended`,
75
+ params: { id },
76
+ });
77
+ }
78
+ }
@@ -0,0 +1,93 @@
1
+ import { Pagination } from '../../types';
2
+
3
+ import {
4
+ CustomerStatus,
5
+ ExtendedCustomerInvoicingStatuses,
6
+ ExtendedCustomerPaymentStrategies,
7
+ ExtendedCustomerStatuses,
8
+ } from './constants';
9
+
10
+ export interface CustomerBillingAddress {
11
+ billingEmail: string[];
12
+ billingContactName?: string;
13
+ billingPhoneNumber?: string;
14
+ country?: string;
15
+ state?: string;
16
+ city?: string;
17
+ streetAddress?: string;
18
+ zipCode?: string | number;
19
+ }
20
+
21
+ export interface Customer {
22
+ Id: string;
23
+ Name: string;
24
+ Status: CustomerStatus;
25
+ Billable?: boolean;
26
+ BillingAddress?: CustomerBillingAddress;
27
+ IdwCustomerId?: string;
28
+ }
29
+
30
+ export type GetExtendedCustomersParams = {
31
+ id?: string;
32
+ name?: string;
33
+ billable?: boolean;
34
+ chargeCreditCard?: boolean;
35
+ domains?: string[];
36
+ approver?: string[];
37
+ managerId?: string;
38
+ parentCustomer?: string;
39
+ idwCustomerId?: string;
40
+ status?: ExtendedCustomerStatuses;
41
+ paymentStrategy?: ExtendedCustomerPaymentStrategies;
42
+ invoicingStatus?: ExtendedCustomerInvoicingStatuses;
43
+ stripeCustomerId?: string;
44
+ paymentProviderId?: string;
45
+ } & Pagination;
46
+
47
+ export type MappedProvider = {
48
+ id: string;
49
+ name: string;
50
+ providerKeys?: string[];
51
+ };
52
+
53
+ // TODO: Extend from base customers
54
+ export type ExtendedCustomer = {
55
+ aNCustomerId?: string;
56
+ approverIds?: string[];
57
+ billable?: boolean;
58
+ billingAddress?: CustomerBillingAddress;
59
+ chargeCreditCard?: boolean;
60
+ created?: string;
61
+ customerProfileId?: string;
62
+ deliverInvoiceEmail?: boolean;
63
+ deliverInvoiceMail?: boolean;
64
+ domains?: string[];
65
+ endDate?: string;
66
+ friendlyName?: string;
67
+ id: string;
68
+ idwCustomerId?: string;
69
+ invoicingStatus?: ExtendedCustomerInvoicingStatuses;
70
+ managerId?: string;
71
+ name?: string;
72
+ parentCustomer?: string;
73
+ paymentProfileId?: string;
74
+ paymentStrategy?: ExtendedCustomerPaymentStrategies;
75
+ pageId?: string;
76
+ shortcode?: string;
77
+ slackChannel?: string;
78
+ startDate?: string;
79
+ status?: ExtendedCustomerStatuses;
80
+ stripeCustomerId?: string;
81
+ type?: string;
82
+ sendInvoiceCsv?: boolean;
83
+ providers?: MappedProvider[];
84
+ paymentProviderId?: string;
85
+ };
86
+
87
+ type UpdateMappedProvider = Omit<MappedProvider, 'name'> & { name?: string; };
88
+
89
+ export type CreateExtendedCustomerParams = Omit<Customer, 'id' | 'providers'> & {
90
+ providers?: UpdateMappedProvider[];
91
+ };
92
+
93
+ export type UpdateExtendedCustomerParams = CreateExtendedCustomerParams;
package/src/api/index.ts CHANGED
@@ -1,7 +1,8 @@
1
- export { default as CustomersApi } from './customersApi';
1
+ export { default as CustomersApi } from './customers-api/customersApi';
2
2
  export { default as EnvironmentsApi } from './environmentsApi';
3
3
  export { default as AccountsApi } from './accountsApi';
4
4
  export { default as CategoriesApi } from './categoriesApi';
5
5
  export { default as MappingApi } from './mappingApi';
6
6
  export { default as FlowsApi } from './flowsApi';
7
7
  export { default as ReportingApi } from './reportingApi';
8
+ export { default as ProvidersApi } from './reportingApi';
@@ -0,0 +1,83 @@
1
+ import { ListPaymentProviderParams, PaymentProvider, Provider } from '../types';
2
+
3
+ import { BaseApi } from './baseApi';
4
+
5
+ export default class ProvidersApi extends BaseApi {
6
+ private readonly apiBasePath = 'api/v1/providers';
7
+
8
+ /**
9
+ * Retrieves a list of providers
10
+ * @param id - Optional provider ID to filter results
11
+ * @returns Promise with array of Provider objects
12
+ */
13
+ async listProviders(id?: string): Promise<Provider[]> {
14
+ return await this.apiCall({
15
+ method: 'GET',
16
+ route: this.apiBasePath,
17
+ params: { id },
18
+ });
19
+ }
20
+
21
+ /**
22
+ * Creates a new provider
23
+ * @param name - Name of the provider to create
24
+ * @returns Promise with created Provider object
25
+ */
26
+ async createProvider(name: string): Promise<Provider> {
27
+ return await this.apiCall({
28
+ method: 'POST',
29
+ route: this.apiBasePath,
30
+ data: { name },
31
+ });
32
+ }
33
+
34
+ /**
35
+ * Deletes a provider
36
+ * @param id - ID of the provider to delete
37
+ */
38
+ async deleteProvider(id: string): Promise<void> {
39
+ return await this.apiCall({
40
+ method: 'DELETE',
41
+ route: this.apiBasePath,
42
+ params: { id },
43
+ });
44
+ }
45
+
46
+ /**
47
+ * Retrieves a list of payment providers
48
+ * @param params - Optional parameters to filter payment providers
49
+ * @returns Promise with array of PaymentProvider objects
50
+ */
51
+ async listPaymentProviders(params?: ListPaymentProviderParams): Promise<PaymentProvider[]> {
52
+ return await this.apiCall({
53
+ method: 'GET',
54
+ route: `${this.apiBasePath}/payment`,
55
+ params,
56
+ });
57
+ }
58
+
59
+ /**
60
+ * Creates a new payment provider
61
+ * @param name - Name of the payment provider to create
62
+ * @returns Promise with created PaymentProvider object
63
+ */
64
+ async createPaymentProvider(name: string): Promise<PaymentProvider> {
65
+ return await this.apiCall({
66
+ method: 'POST',
67
+ route: `${this.apiBasePath}/payment`,
68
+ data: { name },
69
+ });
70
+ }
71
+
72
+ /**
73
+ * Deletes a payment provider
74
+ * @param id - ID of the payment provider to delete
75
+ */
76
+ async deletePaymentProvider(id: string): Promise<void> {
77
+ return await this.apiCall({
78
+ method: 'DELETE',
79
+ route: `${this.apiBasePath}/payment`,
80
+ params: { id },
81
+ });
82
+ }
83
+ }
package/src/constants.ts CHANGED
@@ -1 +1,6 @@
1
1
  export const SERVICE_KEY = 'customer-portal-api';
2
+
3
+ export enum OrderDirection {
4
+ ASC = 'ASC',
5
+ DESC = 'DESC',
6
+ }