Skip to content

Commit 132ad09

Browse files
authored
feat(compare-comply): new model ContractCurrencies added (#935)
* also, fix copyrights in generated unit tests
1 parent 44b7004 commit 132ad09

10 files changed

+64
-78
lines changed

compare-comply/v1.ts

+55-69
Original file line numberDiff line numberDiff line change
@@ -430,8 +430,8 @@ class CompareComplyV1 extends BaseService {
430430
* @param {string} [params.model_version] - An optional string that filters the output to include only feedback with
431431
* the specified `model_version`.
432432
* @param {string} [params.category_removed] - An optional string in the form of a comma-separated list of categories.
433-
* If this is specified, the service filters the output to include only feedback that has at least one category from
434-
* the list removed.
433+
* If it is specified, the service filters the output to include only feedback that has at least one category from the
434+
* list removed.
435435
* @param {string} [params.category_added] - An optional string in the form of a comma-separated list of categories.
436436
* If this is specified, the service filters the output to include only feedback that has at least one category from
437437
* the list added.
@@ -1112,7 +1112,7 @@ namespace CompareComplyV1 {
11121112
model_id?: string;
11131113
/** An optional string that filters the output to include only feedback with the specified `model_version`. */
11141114
model_version?: string;
1115-
/** An optional string in the form of a comma-separated list of categories. If this is specified, the service filters the output to include only feedback that has at least one category from the list removed. */
1115+
/** An optional string in the form of a comma-separated list of categories. If it is specified, the service filters the output to include only feedback that has at least one category from the list removed. */
11161116
category_removed?: string;
11171117
/** An optional string in the form of a comma-separated list of categories. If this is specified, the service filters the output to include only feedback that has at least one category from the list added. */
11181118
category_added?: string;
@@ -1269,7 +1269,7 @@ namespace CompareComplyV1 {
12691269
element_pair?: ElementPair[];
12701270
/** Specifies whether the aligned element is identical. Elements are considered identical despite minor differences such as leading punctuation, end-of-sentence punctuation, whitespace, the presence or absence of definite or indefinite articles, and others. */
12711271
identical_text?: boolean;
1272-
/** One or more hashed values that you can send to IBM to provide feedback or receive support. */
1272+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
12731273
provenance_ids?: string[];
12741274
/** Indicates that the elements aligned are contractual clauses of significance. */
12751275
significant_elements?: boolean;
@@ -1331,20 +1331,26 @@ namespace CompareComplyV1 {
13311331
column_index_begin?: number;
13321332
/** The `end` index of this cell's `column` location in the current table. */
13331333
column_index_end?: number;
1334-
row_header_ids?: RowHeaderIds[];
1335-
row_header_texts?: RowHeaderTexts[];
1336-
row_header_texts_normalized?: RowHeaderTextsNormalized[];
1337-
column_header_ids?: ColumnHeaderIds[];
1338-
column_header_texts?: ColumnHeaderTexts[];
1339-
column_header_texts_normalized?: ColumnHeaderTextsNormalized[];
1334+
/** An array that contains the `id` value of a row header that is applicable to this body cell. */
1335+
row_header_ids?: string[];
1336+
/** An array that contains the `text` value of a row header that is applicable to this body cell. */
1337+
row_header_texts?: string[];
1338+
/** If you provide customization input, the normalized version of the row header texts according to the customization; otherwise, the same value as `row_header_texts`. */
1339+
row_header_texts_normalized?: string[];
1340+
/** An array that contains the `id` value of a column header that is applicable to the current cell. */
1341+
column_header_ids?: string[];
1342+
/** An array that contains the `text` value of a column header that is applicable to the current cell. */
1343+
column_header_texts?: string[];
1344+
/** If you provide customization input, the normalized version of the column header texts according to the customization; otherwise, the same value as `column_header_texts`. */
1345+
column_header_texts_normalized?: string[];
13401346
attributes?: Attribute[];
13411347
}
13421348

13431349
/** Information defining an element's subject matter. */
13441350
export interface Category {
13451351
/** The category of the associated element. */
13461352
label?: string;
1347-
/** One or more hashed values that you can send to IBM to provide feedback or receive support. */
1353+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
13481354
provenance_ids?: string[];
13491355
}
13501356

@@ -1368,14 +1374,16 @@ namespace CompareComplyV1 {
13681374
effective_dates?: EffectiveDates[];
13691375
/** The monetary amounts that identify the total amount of the contract that needs to be paid from one party to another. */
13701376
contract_amounts?: ContractAmts[];
1371-
/** The date or dates on which the document is to be terminated. */
1377+
/** The dates on which the document is to be terminated. */
13721378
termination_dates?: TerminationDates[];
1373-
/** The document's contract type or types as declared in the document. */
1379+
/** The contract type as declared in the document. */
13741380
contract_types?: ContractTypes[];
1375-
/** The duration or durations of the contract. */
1381+
/** The durations of the contract. */
13761382
contract_terms?: ContractTerms[];
1377-
/** The document's payment duration or durations. */
1383+
/** The document's payment durations. */
13781384
payment_terms?: PaymentTerms[];
1385+
/** The contract currencies as declared in the document. */
1386+
contract_currencies?: ContractCurrencies[];
13791387
/** Definition of tables identified in the input document. */
13801388
tables?: Tables[];
13811389
/** The structure of the input document. */
@@ -1384,24 +1392,6 @@ namespace CompareComplyV1 {
13841392
parties?: Parties[];
13851393
}
13861394

1387-
/** An array of values, each being the `id` value of a column header that is applicable to the current cell. */
1388-
export interface ColumnHeaderIds {
1389-
/** The `id` value of a column header. */
1390-
id?: string;
1391-
}
1392-
1393-
/** An array of values, each being the `text` value of a column header that is applicable to the current cell. */
1394-
export interface ColumnHeaderTexts {
1395-
/** The `text` value of a column header. */
1396-
text?: string;
1397-
}
1398-
1399-
/** If you provide customization input, the normalized version of the column header texts according to the customization; otherwise, the same value as `column_header_texts`. */
1400-
export interface ColumnHeaderTextsNormalized {
1401-
/** The normalized version of a column header text. */
1402-
text_normalized?: string;
1403-
}
1404-
14051395
/** Column-level cells, each applicable as a header to other cells in the same column as itself, of the current table. */
14061396
export interface ColumnHeaders {
14071397
/** The unique ID of the cell in the current table. */
@@ -1458,11 +1448,25 @@ namespace CompareComplyV1 {
14581448
confidence_level?: string;
14591449
/** The monetary amount. */
14601450
text?: string;
1461-
/** The normalized form of the amount, which is listed as a string. This element is optional; that is, the service output lists it only if normalized text exists. */
1451+
/** The normalized form of the amount, which is listed as a string. This element is optional; it is returned only if normalized text exists. */
14621452
text_normalized?: string;
1463-
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
1453+
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
14641454
interpretation?: Interpretation;
1465-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1455+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
1456+
provenance_ids?: string[];
1457+
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
1458+
location?: Location;
1459+
}
1460+
1461+
/** The contract currencies that are declared in the document. */
1462+
export interface ContractCurrencies {
1463+
/** The confidence level in the identification of the contract currency. */
1464+
confidence_level?: string;
1465+
/** The contract currency. */
1466+
text?: string;
1467+
/** The normalized form of the contract currency, which is listed as a string in [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) format. This element is optional; it is returned only if normalized text exists. */
1468+
text_normalized?: string;
1469+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
14661470
provenance_ids?: string[];
14671471
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
14681472
location?: Location;
@@ -1474,11 +1478,11 @@ namespace CompareComplyV1 {
14741478
confidence_level?: string;
14751479
/** The contract term (duration). */
14761480
text?: string;
1477-
/** The normalized form of the contract term, which is listed as a string. This element is optional; that is, the service output lists it only if normalized text exists. */
1481+
/** The normalized form of the contract term, which is listed as a string. This element is optional; it is returned only if normalized text exists. */
14781482
text_normalized?: string;
1479-
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
1483+
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
14801484
interpretation?: Interpretation;
1481-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1485+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
14821486
provenance_ids?: string[];
14831487
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
14841488
location?: Location;
@@ -1490,7 +1494,7 @@ namespace CompareComplyV1 {
14901494
confidence_level?: string;
14911495
/** The contract type. */
14921496
text?: string;
1493-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1497+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
14941498
provenance_ids?: string[];
14951499
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
14961500
location?: Location;
@@ -1546,9 +1550,9 @@ namespace CompareComplyV1 {
15461550
confidence_level?: string;
15471551
/** The effective date, listed as a string. */
15481552
text?: string;
1549-
/** The normalized form of the effective date, which is listed as a string. This element is optional; that is, the service output lists it only if normalized text exists. */
1553+
/** The normalized form of the effective date, which is listed as a string. This element is optional; it is returned only if normalized text exists. */
15501554
text_normalized?: string;
1551-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1555+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
15521556
provenance_ids?: string[];
15531557
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
15541558
location?: Location;
@@ -1688,7 +1692,7 @@ namespace CompareComplyV1 {
16881692
html?: string;
16891693
}
16901694

1691-
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
1695+
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
16921696
export interface Interpretation {
16931697
/** The value that was located in the normalized text. */
16941698
value?: string;
@@ -1712,8 +1716,8 @@ namespace CompareComplyV1 {
17121716
export interface KeyValuePair {
17131717
/** A key in a key-value pair. */
17141718
key?: Key;
1715-
/** A value in a key-value pair. */
1716-
value?: Value;
1719+
/** A list of values in a key-value pair. */
1720+
value?: Value[];
17171721
}
17181722

17191723
/** A pair of `nature` and `party` objects. The `nature` object identifies the effect of the element on the identified `party`, and the `party` object identifies the affected party. */
@@ -1810,34 +1814,16 @@ namespace CompareComplyV1 {
18101814
confidence_level?: string;
18111815
/** The payment term (duration). */
18121816
text?: string;
1813-
/** The normalized form of the payment term, which is listed as a string. This element is optional; that is, the service output lists it only if normalized text exists. */
1817+
/** The normalized form of the payment term, which is listed as a string. This element is optional; it is returned only if normalized text exists. */
18141818
text_normalized?: string;
1815-
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
1819+
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
18161820
interpretation?: Interpretation;
1817-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1821+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
18181822
provenance_ids?: string[];
18191823
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
18201824
location?: Location;
18211825
}
18221826

1823-
/** An array of values, each being the `id` value of a row header that is applicable to this body cell. */
1824-
export interface RowHeaderIds {
1825-
/** The `id` values of a row header. */
1826-
id?: string;
1827-
}
1828-
1829-
/** An array of values, each being the `text` value of a row header that is applicable to this body cell. */
1830-
export interface RowHeaderTexts {
1831-
/** The `text` value of a row header. */
1832-
text?: string;
1833-
}
1834-
1835-
/** If you provide customization input, the normalized version of the row header texts according to the customization; otherwise, the same value as `row_header_texts`. */
1836-
export interface RowHeaderTextsNormalized {
1837-
/** The normalized version of a row header text. */
1838-
text_normalized?: string;
1839-
}
1840-
18411827
/** Row-level cells, each applicable as a header to other cells in the same row as itself, of the current table. */
18421828
export interface RowHeaders {
18431829
/** The unique ID of the cell in the current table. */
@@ -1954,9 +1940,9 @@ namespace CompareComplyV1 {
19541940
confidence_level?: string;
19551941
/** The termination date. */
19561942
text?: string;
1957-
/** The normalized form of the termination date, which is listed as a string. This element is optional; that is, the service output lists it only if normalized text exists. */
1943+
/** The normalized form of the termination date, which is listed as a string. This element is optional; it is returned only if normalized text exists. */
19581944
text_normalized?: string;
1959-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1945+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
19601946
provenance_ids?: string[];
19611947
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
19621948
location?: Location;
@@ -1966,7 +1952,7 @@ namespace CompareComplyV1 {
19661952
export interface TypeLabel {
19671953
/** A pair of `nature` and `party` objects. The `nature` object identifies the effect of the element on the identified `party`, and the `party` object identifies the affected party. */
19681954
label?: Label;
1969-
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
1955+
/** Hashed values that you can send to IBM to provide feedback or receive support. */
19701956
provenance_ids?: string[];
19711957
}
19721958

test/unit/assistant.v1.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019 IBM All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2019.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

test/unit/compare-comply.v1.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019 IBM All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2019.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

test/unit/discovery.v1.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019 IBM All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2019.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

test/unit/language-translator.v3.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019 IBM All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2019.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

test/unit/natural-language-classifier.v1.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019 IBM All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2019.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

test/unit/natural-language-understanding.v1.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019 IBM All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2019.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

test/unit/speech-to-text.v1.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019 IBM All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2019.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

test/unit/text-to-speech.v1.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019 IBM All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2019.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

test/unit/visual-recognition.v3.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2019 IBM All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2018, 2019.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)