@managespace/sdk 0.0.85 → 0.0.86

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 (110) hide show
  1. package/dist/extensibility/functions/project/billing.d.ts +2 -25
  2. package/dist/extensibility/functions/project/billing.d.ts.map +1 -1
  3. package/dist/extensibility/functions/project/billing.js +1 -20
  4. package/dist/extensibility/functions/project/document.d.ts +27 -9
  5. package/dist/extensibility/functions/project/document.d.ts.map +1 -1
  6. package/dist/extensibility/functions/project/document.js +10 -0
  7. package/dist/extensibility/functions/project/topics.type.d.ts +2 -0
  8. package/dist/extensibility/functions/project/topics.type.d.ts.map +1 -0
  9. package/dist/extensibility/functions/project/topics.type.js +2 -0
  10. package/dist/generated/apis/default-api.d.ts +27 -48
  11. package/dist/generated/apis/default-api.d.ts.map +1 -1
  12. package/dist/generated/apis/default-api.js +80 -151
  13. package/dist/generated/models/charge-response.d.ts +33 -118
  14. package/dist/generated/models/charge-response.d.ts.map +1 -1
  15. package/dist/generated/models/charge-response.js +53 -56
  16. package/dist/generated/models/create-billing-run.d.ts +4 -4
  17. package/dist/generated/models/create-billing-run.d.ts.map +1 -1
  18. package/dist/generated/models/create-billing-run.js +12 -4
  19. package/dist/generated/models/create-document.d.ts +17 -3
  20. package/dist/generated/models/create-document.d.ts.map +1 -1
  21. package/dist/generated/models/create-document.js +9 -3
  22. package/dist/generated/models/create-payment.d.ts +27 -57
  23. package/dist/generated/models/create-payment.d.ts.map +1 -1
  24. package/dist/generated/models/create-payment.js +27 -27
  25. package/dist/generated/models/create-template.d.ts +12 -10
  26. package/dist/generated/models/create-template.d.ts.map +1 -1
  27. package/dist/generated/models/create-template.js +12 -14
  28. package/dist/generated/models/document-field.d.ts +45 -0
  29. package/dist/generated/models/document-field.d.ts.map +1 -0
  30. package/dist/generated/models/document-field.js +59 -0
  31. package/dist/generated/models/document-signer.d.ts +52 -0
  32. package/dist/generated/models/document-signer.d.ts.map +1 -0
  33. package/dist/generated/models/document-signer.js +62 -0
  34. package/dist/generated/models/field-area.d.ts +57 -0
  35. package/dist/generated/models/field-area.d.ts.map +1 -0
  36. package/dist/generated/models/field-area.js +67 -0
  37. package/dist/generated/models/field-preferences.d.ts +45 -0
  38. package/dist/generated/models/field-preferences.d.ts.map +1 -0
  39. package/dist/generated/models/field-preferences.js +53 -0
  40. package/dist/generated/models/field-type.d.ts +29 -0
  41. package/dist/generated/models/field-type.d.ts.map +1 -0
  42. package/dist/generated/models/field-type.js +54 -0
  43. package/dist/generated/models/get-templates200-response.d.ts +41 -0
  44. package/dist/generated/models/get-templates200-response.d.ts.map +1 -0
  45. package/dist/generated/models/get-templates200-response.js +55 -0
  46. package/dist/generated/models/index.d.ts +10 -6
  47. package/dist/generated/models/index.d.ts.map +1 -1
  48. package/dist/generated/models/index.js +10 -6
  49. package/dist/generated/models/payment-response.d.ts +57 -58
  50. package/dist/generated/models/payment-response.d.ts.map +1 -1
  51. package/dist/generated/models/payment-response.js +68 -39
  52. package/dist/generated/models/revenue-rule-response.d.ts +6 -6
  53. package/dist/generated/models/revenue-rule-response.d.ts.map +1 -1
  54. package/dist/generated/models/revenue-rule-response.js +4 -4
  55. package/dist/generated/models/template-field.d.ts +54 -0
  56. package/dist/generated/models/template-field.d.ts.map +1 -0
  57. package/dist/generated/models/template-field.js +64 -0
  58. package/dist/generated/models/template-response.d.ts +59 -0
  59. package/dist/generated/models/template-response.d.ts.map +1 -0
  60. package/dist/generated/models/template-response.js +65 -0
  61. package/dist/generated/models/template-signer.d.ts +40 -0
  62. package/dist/generated/models/template-signer.d.ts.map +1 -0
  63. package/dist/generated/models/template-signer.js +54 -0
  64. package/package.json +2 -2
  65. package/src/extensibility/functions/project/billing.ts +3 -33
  66. package/src/extensibility/functions/project/document.ts +19 -9
  67. package/src/generated/.openapi-generator/FILES +10 -6
  68. package/src/generated/apis/default-api.ts +125 -259
  69. package/src/generated/models/charge-response.ts +73 -179
  70. package/src/generated/models/create-billing-run.ts +12 -8
  71. package/src/generated/models/create-document.ts +37 -6
  72. package/src/generated/models/create-payment.ts +49 -84
  73. package/src/generated/models/create-template.ts +35 -22
  74. package/src/generated/models/document-field.ts +84 -0
  75. package/src/generated/models/document-signer.ts +100 -0
  76. package/src/generated/models/field-area.ts +102 -0
  77. package/src/generated/models/field-preferences.ts +81 -0
  78. package/src/generated/models/field-type.ts +56 -0
  79. package/src/generated/models/get-templates200-response.ts +89 -0
  80. package/src/generated/models/index.ts +10 -6
  81. package/src/generated/models/payment-response.ts +113 -105
  82. package/src/generated/models/revenue-rule-response.ts +9 -9
  83. package/src/generated/models/template-field.ts +116 -0
  84. package/src/generated/models/template-response.ts +115 -0
  85. package/src/generated/models/template-signer.ts +82 -0
  86. package/.turbo/turbo-build.log +0 -2
  87. package/dist/generated/models/charge-tier.d.ts +0 -57
  88. package/dist/generated/models/charge-tier.d.ts.map +0 -1
  89. package/dist/generated/models/charge-tier.js +0 -65
  90. package/dist/generated/models/create-charge.d.ts +0 -233
  91. package/dist/generated/models/create-charge.d.ts.map +0 -1
  92. package/dist/generated/models/create-charge.js +0 -131
  93. package/dist/generated/models/create-order.d.ts +0 -136
  94. package/dist/generated/models/create-order.d.ts.map +0 -1
  95. package/dist/generated/models/create-order.js +0 -98
  96. package/dist/generated/models/get-orders200-response.d.ts +0 -41
  97. package/dist/generated/models/get-orders200-response.d.ts.map +0 -1
  98. package/dist/generated/models/get-orders200-response.js +0 -55
  99. package/dist/generated/models/order-line-item.d.ts +0 -75
  100. package/dist/generated/models/order-line-item.d.ts.map +0 -1
  101. package/dist/generated/models/order-line-item.js +0 -73
  102. package/dist/generated/models/order-response.d.ts +0 -142
  103. package/dist/generated/models/order-response.d.ts.map +0 -1
  104. package/dist/generated/models/order-response.js +0 -102
  105. package/src/generated/models/charge-tier.ts +0 -101
  106. package/src/generated/models/create-charge.ts +0 -351
  107. package/src/generated/models/create-order.ts +0 -216
  108. package/src/generated/models/get-orders200-response.ts +0 -89
  109. package/src/generated/models/order-line-item.ts +0 -126
  110. package/src/generated/models/order-response.ts +0 -225
@@ -1,142 +0,0 @@
1
- /**
2
- * ManageSpace API
3
- * ManageSpace API Documentation
4
- *
5
- * The version of the OpenAPI document: 1.0.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { OrderLineItem } from './order-line-item';
13
- /**
14
- *
15
- * @export
16
- * @interface OrderResponse
17
- */
18
- export interface OrderResponse {
19
- /**
20
- * If order status is invoiced, associated invoice id
21
- * @type {string}
22
- * @memberof OrderResponse
23
- */
24
- invoiceId?: string;
25
- /**
26
- * Date order was placed
27
- * @type {string}
28
- * @memberof OrderResponse
29
- */
30
- orderDate: string;
31
- /**
32
- * Customer ID associated with order
33
- * @type {string}
34
- * @memberof OrderResponse
35
- */
36
- customerId: string;
37
- /**
38
- * Order status
39
- * @type {string}
40
- * @memberof OrderResponse
41
- */
42
- status: string;
43
- /**
44
- * Total amount of order
45
- * @type {string}
46
- * @memberof OrderResponse
47
- */
48
- orderAmount: string;
49
- /**
50
- * Enable to create separate invoice for this order
51
- * @type {boolean}
52
- * @memberof OrderResponse
53
- */
54
- separateInvoice: boolean;
55
- /**
56
- * Currency of the order
57
- * @type {string}
58
- * @memberof OrderResponse
59
- */
60
- currency: string;
61
- /**
62
- * Billing contact ID
63
- * @type {string}
64
- * @memberof OrderResponse
65
- */
66
- billContactId?: string;
67
- /**
68
- * Shipping contact ID
69
- * @type {string}
70
- * @memberof OrderResponse
71
- */
72
- shippingContactId?: string;
73
- /**
74
- * Payment terms to calculate due date of invoice
75
- * @type {string}
76
- * @memberof OrderResponse
77
- */
78
- paymentTerms?: string;
79
- /**
80
- * Misceallaneous notes on order
81
- * @type {string}
82
- * @memberof OrderResponse
83
- */
84
- notes?: string;
85
- /**
86
- * Coupon code applied to order
87
- * @type {string}
88
- * @memberof OrderResponse
89
- */
90
- couponCode?: string;
91
- /**
92
- * Invoice line items
93
- * @type {Array<OrderLineItem>}
94
- * @memberof OrderResponse
95
- */
96
- lineItems: Array<OrderLineItem>;
97
- /**
98
- * The date the order was created
99
- * @type {string}
100
- * @memberof OrderResponse
101
- */
102
- createdAt?: string;
103
- /**
104
- * The date the order was updated
105
- * @type {string}
106
- * @memberof OrderResponse
107
- */
108
- updatedAt?: string;
109
- /**
110
- * Who created the order
111
- * @type {string}
112
- * @memberof OrderResponse
113
- */
114
- createdBy?: string;
115
- /**
116
- * Who updated the order
117
- * @type {string}
118
- * @memberof OrderResponse
119
- */
120
- updatedBy?: string;
121
- /**
122
- * Custom fields on the invoice
123
- * @type {object}
124
- * @memberof OrderResponse
125
- */
126
- customFields?: object;
127
- /**
128
- * Order ID
129
- * @type {string}
130
- * @memberof OrderResponse
131
- */
132
- id: string;
133
- }
134
- /**
135
- * Check if a given object implements the OrderResponse interface.
136
- */
137
- export declare function instanceOfOrderResponse(value: object): value is OrderResponse;
138
- export declare function OrderResponseFromJSON(json: any): OrderResponse;
139
- export declare function OrderResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderResponse;
140
- export declare function OrderResponseToJSON(json: any): OrderResponse;
141
- export declare function OrderResponseToJSONTyped(value?: OrderResponse | null, ignoreDiscriminator?: boolean): any;
142
- //# sourceMappingURL=order-response.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"order-response.d.ts","sourceRoot":"","sources":["../../../src/generated/models/order-response.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAQvD;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAChC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,aAAa,CAU7E;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,GAAG,GAAG,aAAa,CAE9D;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,aAAa,CA0BjG;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,GAAG,GAAG,aAAa,CAE5D;AAED,wBAAgB,wBAAwB,CAAC,KAAK,CAAC,EAAE,aAAa,GAAG,IAAI,EAAE,mBAAmB,GAAE,OAAe,GAAG,GAAG,CA2BhH"}
@@ -1,102 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * ManageSpace API
6
- * ManageSpace API Documentation
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.OrderResponseToJSONTyped = exports.OrderResponseToJSON = exports.OrderResponseFromJSONTyped = exports.OrderResponseFromJSON = exports.instanceOfOrderResponse = void 0;
17
- const order_line_item_1 = require("./order-line-item");
18
- /**
19
- * Check if a given object implements the OrderResponse interface.
20
- */
21
- function instanceOfOrderResponse(value) {
22
- if (!('orderDate' in value) || value['orderDate'] === undefined)
23
- return false;
24
- if (!('customerId' in value) || value['customerId'] === undefined)
25
- return false;
26
- if (!('status' in value) || value['status'] === undefined)
27
- return false;
28
- if (!('orderAmount' in value) || value['orderAmount'] === undefined)
29
- return false;
30
- if (!('separateInvoice' in value) || value['separateInvoice'] === undefined)
31
- return false;
32
- if (!('currency' in value) || value['currency'] === undefined)
33
- return false;
34
- if (!('lineItems' in value) || value['lineItems'] === undefined)
35
- return false;
36
- if (!('id' in value) || value['id'] === undefined)
37
- return false;
38
- return true;
39
- }
40
- exports.instanceOfOrderResponse = instanceOfOrderResponse;
41
- function OrderResponseFromJSON(json) {
42
- return OrderResponseFromJSONTyped(json, false);
43
- }
44
- exports.OrderResponseFromJSON = OrderResponseFromJSON;
45
- function OrderResponseFromJSONTyped(json, ignoreDiscriminator) {
46
- if (json == null) {
47
- return json;
48
- }
49
- return {
50
- 'invoiceId': json['invoiceId'] == null ? undefined : json['invoiceId'],
51
- 'orderDate': json['orderDate'],
52
- 'customerId': json['customerId'],
53
- 'status': json['status'],
54
- 'orderAmount': json['orderAmount'],
55
- 'separateInvoice': json['separateInvoice'],
56
- 'currency': json['currency'],
57
- 'billContactId': json['billContactId'] == null ? undefined : json['billContactId'],
58
- 'shippingContactId': json['shippingContactId'] == null ? undefined : json['shippingContactId'],
59
- 'paymentTerms': json['paymentTerms'] == null ? undefined : json['paymentTerms'],
60
- 'notes': json['notes'] == null ? undefined : json['notes'],
61
- 'couponCode': json['couponCode'] == null ? undefined : json['couponCode'],
62
- 'lineItems': (json['lineItems'].map(order_line_item_1.OrderLineItemFromJSON)),
63
- 'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
64
- 'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
65
- 'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
66
- 'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
67
- 'customFields': json['customFields'] == null ? undefined : json['customFields'],
68
- 'id': json['id'],
69
- };
70
- }
71
- exports.OrderResponseFromJSONTyped = OrderResponseFromJSONTyped;
72
- function OrderResponseToJSON(json) {
73
- return OrderResponseToJSONTyped(json, false);
74
- }
75
- exports.OrderResponseToJSON = OrderResponseToJSON;
76
- function OrderResponseToJSONTyped(value, ignoreDiscriminator = false) {
77
- if (value == null) {
78
- return value;
79
- }
80
- return {
81
- 'invoiceId': value['invoiceId'],
82
- 'orderDate': value['orderDate'],
83
- 'customerId': value['customerId'],
84
- 'status': value['status'],
85
- 'orderAmount': value['orderAmount'],
86
- 'separateInvoice': value['separateInvoice'],
87
- 'currency': value['currency'],
88
- 'billContactId': value['billContactId'],
89
- 'shippingContactId': value['shippingContactId'],
90
- 'paymentTerms': value['paymentTerms'],
91
- 'notes': value['notes'],
92
- 'couponCode': value['couponCode'],
93
- 'lineItems': (value['lineItems'].map(order_line_item_1.OrderLineItemToJSON)),
94
- 'createdAt': value['createdAt'],
95
- 'updatedAt': value['updatedAt'],
96
- 'createdBy': value['createdBy'],
97
- 'updatedBy': value['updatedBy'],
98
- 'customFields': value['customFields'],
99
- 'id': value['id'],
100
- };
101
- }
102
- exports.OrderResponseToJSONTyped = OrderResponseToJSONTyped;
@@ -1,101 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * ManageSpace API
5
- * ManageSpace API Documentation
6
- *
7
- * The version of the OpenAPI document: 1.0.0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
- import { mapValues } from '../runtime';
16
- /**
17
- *
18
- * @export
19
- * @interface ChargeTier
20
- */
21
- export interface ChargeTier {
22
- /**
23
- * Tier number
24
- * @type {number}
25
- * @memberof ChargeTier
26
- */
27
- tier: number;
28
- /**
29
- * Unit that we will being charging the price in this tier
30
- * @type {number}
31
- * @memberof ChargeTier
32
- */
33
- startingUnit: number;
34
- /**
35
- * Unit we will end charging price in this tier
36
- * @type {number}
37
- * @memberof ChargeTier
38
- */
39
- endingUnit?: number;
40
- /**
41
- * Price per unit in this tier
42
- * @type {string}
43
- * @memberof ChargeTier
44
- */
45
- price: string;
46
- /**
47
- * Type of price for tier
48
- * @type {string}
49
- * @memberof ChargeTier
50
- */
51
- type: string;
52
- }
53
-
54
- /**
55
- * Check if a given object implements the ChargeTier interface.
56
- */
57
- export function instanceOfChargeTier(value: object): value is ChargeTier {
58
- if (!('tier' in value) || value['tier'] === undefined) return false;
59
- if (!('startingUnit' in value) || value['startingUnit'] === undefined) return false;
60
- if (!('price' in value) || value['price'] === undefined) return false;
61
- if (!('type' in value) || value['type'] === undefined) return false;
62
- return true;
63
- }
64
-
65
- export function ChargeTierFromJSON(json: any): ChargeTier {
66
- return ChargeTierFromJSONTyped(json, false);
67
- }
68
-
69
- export function ChargeTierFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChargeTier {
70
- if (json == null) {
71
- return json;
72
- }
73
- return {
74
-
75
- 'tier': json['tier'],
76
- 'startingUnit': json['startingUnit'],
77
- 'endingUnit': json['endingUnit'] == null ? undefined : json['endingUnit'],
78
- 'price': json['price'],
79
- 'type': json['type'],
80
- };
81
- }
82
-
83
- export function ChargeTierToJSON(json: any): ChargeTier {
84
- return ChargeTierToJSONTyped(json, false);
85
- }
86
-
87
- export function ChargeTierToJSONTyped(value?: ChargeTier | null, ignoreDiscriminator: boolean = false): any {
88
- if (value == null) {
89
- return value;
90
- }
91
-
92
- return {
93
-
94
- 'tier': value['tier'],
95
- 'startingUnit': value['startingUnit'],
96
- 'endingUnit': value['endingUnit'],
97
- 'price': value['price'],
98
- 'type': value['type'],
99
- };
100
- }
101
-
@@ -1,351 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * ManageSpace API
5
- * ManageSpace API Documentation
6
- *
7
- * The version of the OpenAPI document: 1.0.0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
- import { mapValues } from '../runtime';
16
- import type { TransactionPostingEntries } from './transaction-posting-entries';
17
- import {
18
- TransactionPostingEntriesFromJSON,
19
- TransactionPostingEntriesFromJSONTyped,
20
- TransactionPostingEntriesToJSON,
21
- TransactionPostingEntriesToJSONTyped,
22
- } from './transaction-posting-entries';
23
- import type { ChargeTier } from './charge-tier';
24
- import {
25
- ChargeTierFromJSON,
26
- ChargeTierFromJSONTyped,
27
- ChargeTierToJSON,
28
- ChargeTierToJSONTyped,
29
- } from './charge-tier';
30
-
31
- /**
32
- *
33
- * @export
34
- * @interface CreateCharge
35
- */
36
- export interface CreateCharge {
37
- /**
38
- * Product ID
39
- * @type {string}
40
- * @memberof CreateCharge
41
- */
42
- productId: string;
43
- /**
44
- * Name of charge
45
- * @type {string}
46
- * @memberof CreateCharge
47
- */
48
- name: string;
49
- /**
50
- * Description of charge
51
- * @type {string}
52
- * @memberof CreateCharge
53
- */
54
- description?: string;
55
- /**
56
- * Type of charge
57
- * @type {string}
58
- * @memberof CreateCharge
59
- */
60
- type: string;
61
- /**
62
- * timing of one-time charge, to process at start of contract or termination
63
- * @type {string}
64
- * @memberof CreateCharge
65
- */
66
- timing?: string;
67
- /**
68
- * For one-time charges, date charge goes into effect; for custom billing period, provide Billing Period Name
69
- * @type {string}
70
- * @memberof CreateCharge
71
- */
72
- effectiveDate?: string;
73
- /**
74
- * Defines trigger date after which the one-time charges should be processed
75
- * @type {string}
76
- * @memberof CreateCharge
77
- */
78
- billingDate?: string;
79
- /**
80
- * Date can drive bililng and/or revenue recognition upon completion of task
81
- * @type {string}
82
- * @memberof CreateCharge
83
- */
84
- completionDate?: string;
85
- /**
86
- * How charge is priced
87
- * @type {string}
88
- * @memberof CreateCharge
89
- */
90
- pricingModel: string;
91
- /**
92
- * Original unit price of charge
93
- * @type {string}
94
- * @memberof CreateCharge
95
- */
96
- listPrice: string;
97
- /**
98
- * For recurring charges, time of charges
99
- * @type {string}
100
- * @memberof CreateCharge
101
- */
102
- chargeTiming?: string;
103
- /**
104
- * List price base of charge
105
- * @type {string}
106
- * @memberof CreateCharge
107
- */
108
- listPriceBase?: string;
109
- /**
110
- * Billing period
111
- * @type {string}
112
- * @memberof CreateCharge
113
- */
114
- billingPeriod?: string;
115
- /**
116
- * Which day of the month or week Charge is invoiced
117
- * @type {string}
118
- * @memberof CreateCharge
119
- */
120
- billingDay?: string;
121
- /**
122
- * Determine boundary of Charge period
123
- * @type {string}
124
- * @memberof CreateCharge
125
- */
126
- billingPeriodStartAlignment?: string;
127
- /**
128
- * Charge for partial periods
129
- * @type {boolean}
130
- * @memberof CreateCharge
131
- */
132
- proratePartialPeriods?: boolean;
133
- /**
134
- * Number of periods/units to charge
135
- * @type {number}
136
- * @memberof CreateCharge
137
- */
138
- prepaymentPeriods?: number;
139
- /**
140
- * If there is a number of prepayment units you request
141
- * @type {number}
142
- * @memberof CreateCharge
143
- */
144
- prepaymentAmount?: number;
145
- /**
146
- * For usage charges, unit of measure for charge
147
- * @type {string}
148
- * @memberof CreateCharge
149
- */
150
- unitOfMeasure?: string;
151
- /**
152
- * Number of units included in plan for usage based charges (can be float)
153
- * @type {number}
154
- * @memberof CreateCharge
155
- */
156
- includedUnits: number;
157
- /**
158
- * Unused prepayment units remaining for charge
159
- * @type {number}
160
- * @memberof CreateCharge
161
- */
162
- unusedPrepaymentUnits?: number;
163
- /**
164
- * For tiered/volume pricing, each tier will represent price of specific units in given range
165
- * @type {Array<ChargeTier>}
166
- * @memberof CreateCharge
167
- */
168
- tiers?: Array<ChargeTier>;
169
- /**
170
- * Determines proration logic
171
- * @type {boolean}
172
- * @memberof CreateCharge
173
- */
174
- backchargeCurrentPeriod?: boolean;
175
- /**
176
- * Custom fields on the invoice
177
- * @type {object}
178
- * @memberof CreateCharge
179
- */
180
- customFields?: object;
181
- /**
182
- * Ability to bill your customers for a present number of units
183
- * @type {boolean}
184
- * @memberof CreateCharge
185
- */
186
- prepaidUnitsEnable?: boolean;
187
- /**
188
- * Ability to automatically refill number of prepaid units
189
- * @type {boolean}
190
- * @memberof CreateCharge
191
- */
192
- autoRefillPrepaymentUnits?: boolean;
193
- /**
194
- * Refill quantity
195
- * @type {number}
196
- * @memberof CreateCharge
197
- */
198
- refillQty?: number;
199
- /**
200
- * Prepayment refill period
201
- * @type {string}
202
- * @memberof CreateCharge
203
- */
204
- refillPrepaidUnitsFor?: string;
205
- /**
206
- * Remaining balance of prepaid units
207
- * @type {string}
208
- * @memberof CreateCharge
209
- */
210
- prepaidUnitsExpiry?: string;
211
- /**
212
- * Remaining balance of prepaid units to be refunded
213
- * @type {boolean}
214
- * @memberof CreateCharge
215
- */
216
- refundUnitsOnCancel?: boolean;
217
- /**
218
- *
219
- * @type {boolean}
220
- * @memberof CreateCharge
221
- */
222
- defaultFromProduct: boolean;
223
- /**
224
- * Revenue Rule ID
225
- * @type {string}
226
- * @memberof CreateCharge
227
- */
228
- revenueRuleId?: string;
229
- /**
230
- * Date when revenue recognition will begin
231
- * @type {string}
232
- * @memberof CreateCharge
233
- */
234
- recognitionStartDate?: string;
235
- /**
236
- * Transaction type
237
- * @type {Array<TransactionPostingEntries>}
238
- * @memberof CreateCharge
239
- */
240
- transactionPostingEntries?: Array<TransactionPostingEntries>;
241
- }
242
-
243
- /**
244
- * Check if a given object implements the CreateCharge interface.
245
- */
246
- export function instanceOfCreateCharge(value: object): value is CreateCharge {
247
- if (!('productId' in value) || value['productId'] === undefined) return false;
248
- if (!('name' in value) || value['name'] === undefined) return false;
249
- if (!('type' in value) || value['type'] === undefined) return false;
250
- if (!('pricingModel' in value) || value['pricingModel'] === undefined) return false;
251
- if (!('listPrice' in value) || value['listPrice'] === undefined) return false;
252
- if (!('includedUnits' in value) || value['includedUnits'] === undefined) return false;
253
- if (!('defaultFromProduct' in value) || value['defaultFromProduct'] === undefined) return false;
254
- return true;
255
- }
256
-
257
- export function CreateChargeFromJSON(json: any): CreateCharge {
258
- return CreateChargeFromJSONTyped(json, false);
259
- }
260
-
261
- export function CreateChargeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCharge {
262
- if (json == null) {
263
- return json;
264
- }
265
- return {
266
-
267
- 'productId': json['productId'],
268
- 'name': json['name'],
269
- 'description': json['description'] == null ? undefined : json['description'],
270
- 'type': json['type'],
271
- 'timing': json['timing'] == null ? undefined : json['timing'],
272
- 'effectiveDate': json['effectiveDate'] == null ? undefined : json['effectiveDate'],
273
- 'billingDate': json['billingDate'] == null ? undefined : json['billingDate'],
274
- 'completionDate': json['completionDate'] == null ? undefined : json['completionDate'],
275
- 'pricingModel': json['pricingModel'],
276
- 'listPrice': json['listPrice'],
277
- 'chargeTiming': json['chargeTiming'] == null ? undefined : json['chargeTiming'],
278
- 'listPriceBase': json['listPriceBase'] == null ? undefined : json['listPriceBase'],
279
- 'billingPeriod': json['billingPeriod'] == null ? undefined : json['billingPeriod'],
280
- 'billingDay': json['billingDay'] == null ? undefined : json['billingDay'],
281
- 'billingPeriodStartAlignment': json['billingPeriodStartAlignment'] == null ? undefined : json['billingPeriodStartAlignment'],
282
- 'proratePartialPeriods': json['proratePartialPeriods'] == null ? undefined : json['proratePartialPeriods'],
283
- 'prepaymentPeriods': json['prepaymentPeriods'] == null ? undefined : json['prepaymentPeriods'],
284
- 'prepaymentAmount': json['prepaymentAmount'] == null ? undefined : json['prepaymentAmount'],
285
- 'unitOfMeasure': json['unitOfMeasure'] == null ? undefined : json['unitOfMeasure'],
286
- 'includedUnits': json['includedUnits'],
287
- 'unusedPrepaymentUnits': json['unusedPrepaymentUnits'] == null ? undefined : json['unusedPrepaymentUnits'],
288
- 'tiers': json['tiers'] == null ? undefined : ((json['tiers'] as Array<any>).map(ChargeTierFromJSON)),
289
- 'backchargeCurrentPeriod': json['backchargeCurrentPeriod'] == null ? undefined : json['backchargeCurrentPeriod'],
290
- 'customFields': json['customFields'] == null ? undefined : json['customFields'],
291
- 'prepaidUnitsEnable': json['prepaidUnitsEnable'] == null ? undefined : json['prepaidUnitsEnable'],
292
- 'autoRefillPrepaymentUnits': json['autoRefillPrepaymentUnits'] == null ? undefined : json['autoRefillPrepaymentUnits'],
293
- 'refillQty': json['refillQty'] == null ? undefined : json['refillQty'],
294
- 'refillPrepaidUnitsFor': json['refillPrepaidUnitsFor'] == null ? undefined : json['refillPrepaidUnitsFor'],
295
- 'prepaidUnitsExpiry': json['prepaidUnitsExpiry'] == null ? undefined : json['prepaidUnitsExpiry'],
296
- 'refundUnitsOnCancel': json['refundUnitsOnCancel'] == null ? undefined : json['refundUnitsOnCancel'],
297
- 'defaultFromProduct': json['defaultFromProduct'],
298
- 'revenueRuleId': json['revenueRuleId'] == null ? undefined : json['revenueRuleId'],
299
- 'recognitionStartDate': json['recognitionStartDate'] == null ? undefined : json['recognitionStartDate'],
300
- 'transactionPostingEntries': json['transactionPostingEntries'] == null ? undefined : ((json['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
301
- };
302
- }
303
-
304
- export function CreateChargeToJSON(json: any): CreateCharge {
305
- return CreateChargeToJSONTyped(json, false);
306
- }
307
-
308
- export function CreateChargeToJSONTyped(value?: CreateCharge | null, ignoreDiscriminator: boolean = false): any {
309
- if (value == null) {
310
- return value;
311
- }
312
-
313
- return {
314
-
315
- 'productId': value['productId'],
316
- 'name': value['name'],
317
- 'description': value['description'],
318
- 'type': value['type'],
319
- 'timing': value['timing'],
320
- 'effectiveDate': value['effectiveDate'],
321
- 'billingDate': value['billingDate'],
322
- 'completionDate': value['completionDate'],
323
- 'pricingModel': value['pricingModel'],
324
- 'listPrice': value['listPrice'],
325
- 'chargeTiming': value['chargeTiming'],
326
- 'listPriceBase': value['listPriceBase'],
327
- 'billingPeriod': value['billingPeriod'],
328
- 'billingDay': value['billingDay'],
329
- 'billingPeriodStartAlignment': value['billingPeriodStartAlignment'],
330
- 'proratePartialPeriods': value['proratePartialPeriods'],
331
- 'prepaymentPeriods': value['prepaymentPeriods'],
332
- 'prepaymentAmount': value['prepaymentAmount'],
333
- 'unitOfMeasure': value['unitOfMeasure'],
334
- 'includedUnits': value['includedUnits'],
335
- 'unusedPrepaymentUnits': value['unusedPrepaymentUnits'],
336
- 'tiers': value['tiers'] == null ? undefined : ((value['tiers'] as Array<any>).map(ChargeTierToJSON)),
337
- 'backchargeCurrentPeriod': value['backchargeCurrentPeriod'],
338
- 'customFields': value['customFields'],
339
- 'prepaidUnitsEnable': value['prepaidUnitsEnable'],
340
- 'autoRefillPrepaymentUnits': value['autoRefillPrepaymentUnits'],
341
- 'refillQty': value['refillQty'],
342
- 'refillPrepaidUnitsFor': value['refillPrepaidUnitsFor'],
343
- 'prepaidUnitsExpiry': value['prepaidUnitsExpiry'],
344
- 'refundUnitsOnCancel': value['refundUnitsOnCancel'],
345
- 'defaultFromProduct': value['defaultFromProduct'],
346
- 'revenueRuleId': value['revenueRuleId'],
347
- 'recognitionStartDate': value['recognitionStartDate'],
348
- 'transactionPostingEntries': value['transactionPostingEntries'] == null ? undefined : ((value['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesToJSON)),
349
- };
350
- }
351
-