Skip to content

Commit

Permalink
feat(compare-comply): new model ContractCurrencies added (#935)
Browse files Browse the repository at this point in the history
* also, fix copyrights in generated unit tests
  • Loading branch information
dpopp07 authored Aug 20, 2019
1 parent 44b7004 commit 132ad09
Show file tree
Hide file tree
Showing 10 changed files with 64 additions and 78 deletions.
124 changes: 55 additions & 69 deletions compare-comply/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -430,8 +430,8 @@ class CompareComplyV1 extends BaseService {
* @param {string} [params.model_version] - An optional string that filters the output to include only feedback with
* the specified `model_version`.
* @param {string} [params.category_removed] - 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.
* If it is specified, the service filters the output to include only feedback that has at least one category from the
* list removed.
* @param {string} [params.category_added] - 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.
Expand Down Expand Up @@ -1112,7 +1112,7 @@ namespace CompareComplyV1 {
model_id?: string;
/** An optional string that filters the output to include only feedback with the specified `model_version`. */
model_version?: string;
/** 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. */
/** 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. */
category_removed?: string;
/** 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. */
category_added?: string;
Expand Down Expand Up @@ -1269,7 +1269,7 @@ namespace CompareComplyV1 {
element_pair?: ElementPair[];
/** 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. */
identical_text?: boolean;
/** One or more hashed values that you can send to IBM to provide feedback or receive support. */
/** Hashed values that you can send to IBM to provide feedback or receive support. */
provenance_ids?: string[];
/** Indicates that the elements aligned are contractual clauses of significance. */
significant_elements?: boolean;
Expand Down Expand Up @@ -1331,20 +1331,26 @@ namespace CompareComplyV1 {
column_index_begin?: number;
/** The `end` index of this cell's `column` location in the current table. */
column_index_end?: number;
row_header_ids?: RowHeaderIds[];
row_header_texts?: RowHeaderTexts[];
row_header_texts_normalized?: RowHeaderTextsNormalized[];
column_header_ids?: ColumnHeaderIds[];
column_header_texts?: ColumnHeaderTexts[];
column_header_texts_normalized?: ColumnHeaderTextsNormalized[];
/** An array that contains the `id` value of a row header that is applicable to this body cell. */
row_header_ids?: string[];
/** An array that contains the `text` value of a row header that is applicable to this body cell. */
row_header_texts?: string[];
/** 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`. */
row_header_texts_normalized?: string[];
/** An array that contains the `id` value of a column header that is applicable to the current cell. */
column_header_ids?: string[];
/** An array that contains the `text` value of a column header that is applicable to the current cell. */
column_header_texts?: string[];
/** 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`. */
column_header_texts_normalized?: string[];
attributes?: Attribute[];
}

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

Expand All @@ -1368,14 +1374,16 @@ namespace CompareComplyV1 {
effective_dates?: EffectiveDates[];
/** The monetary amounts that identify the total amount of the contract that needs to be paid from one party to another. */
contract_amounts?: ContractAmts[];
/** The date or dates on which the document is to be terminated. */
/** The dates on which the document is to be terminated. */
termination_dates?: TerminationDates[];
/** The document's contract type or types as declared in the document. */
/** The contract type as declared in the document. */
contract_types?: ContractTypes[];
/** The duration or durations of the contract. */
/** The durations of the contract. */
contract_terms?: ContractTerms[];
/** The document's payment duration or durations. */
/** The document's payment durations. */
payment_terms?: PaymentTerms[];
/** The contract currencies as declared in the document. */
contract_currencies?: ContractCurrencies[];
/** Definition of tables identified in the input document. */
tables?: Tables[];
/** The structure of the input document. */
Expand All @@ -1384,24 +1392,6 @@ namespace CompareComplyV1 {
parties?: Parties[];
}

/** An array of values, each being the `id` value of a column header that is applicable to the current cell. */
export interface ColumnHeaderIds {
/** The `id` value of a column header. */
id?: string;
}

/** An array of values, each being the `text` value of a column header that is applicable to the current cell. */
export interface ColumnHeaderTexts {
/** The `text` value of a column header. */
text?: string;
}

/** 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`. */
export interface ColumnHeaderTextsNormalized {
/** The normalized version of a column header text. */
text_normalized?: string;
}

/** Column-level cells, each applicable as a header to other cells in the same column as itself, of the current table. */
export interface ColumnHeaders {
/** The unique ID of the cell in the current table. */
Expand Down Expand Up @@ -1458,11 +1448,25 @@ namespace CompareComplyV1 {
confidence_level?: string;
/** The monetary amount. */
text?: string;
/** 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. */
/** The normalized form of the amount, which is listed as a string. This element is optional; it is returned only if normalized text exists. */
text_normalized?: string;
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
interpretation?: Interpretation;
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
/** Hashed values that you can send to IBM to provide feedback or receive support. */
provenance_ids?: string[];
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
location?: Location;
}

/** The contract currencies that are declared in the document. */
export interface ContractCurrencies {
/** The confidence level in the identification of the contract currency. */
confidence_level?: string;
/** The contract currency. */
text?: string;
/** 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. */
text_normalized?: string;
/** Hashed values that you can send to IBM to provide feedback or receive support. */
provenance_ids?: string[];
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
location?: Location;
Expand All @@ -1474,11 +1478,11 @@ namespace CompareComplyV1 {
confidence_level?: string;
/** The contract term (duration). */
text?: string;
/** 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. */
/** 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. */
text_normalized?: string;
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
interpretation?: Interpretation;
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
/** Hashed values that you can send to IBM to provide feedback or receive support. */
provenance_ids?: string[];
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
location?: Location;
Expand All @@ -1490,7 +1494,7 @@ namespace CompareComplyV1 {
confidence_level?: string;
/** The contract type. */
text?: string;
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
/** Hashed values that you can send to IBM to provide feedback or receive support. */
provenance_ids?: string[];
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
location?: Location;
Expand Down Expand Up @@ -1546,9 +1550,9 @@ namespace CompareComplyV1 {
confidence_level?: string;
/** The effective date, listed as a string. */
text?: string;
/** 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. */
/** 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. */
text_normalized?: string;
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
/** Hashed values that you can send to IBM to provide feedback or receive support. */
provenance_ids?: string[];
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
location?: Location;
Expand Down Expand Up @@ -1688,7 +1692,7 @@ namespace CompareComplyV1 {
html?: string;
}

/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
export interface Interpretation {
/** The value that was located in the normalized text. */
value?: string;
Expand All @@ -1712,8 +1716,8 @@ namespace CompareComplyV1 {
export interface KeyValuePair {
/** A key in a key-value pair. */
key?: Key;
/** A value in a key-value pair. */
value?: Value;
/** A list of values in a key-value pair. */
value?: Value[];
}

/** 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. */
Expand Down Expand Up @@ -1810,34 +1814,16 @@ namespace CompareComplyV1 {
confidence_level?: string;
/** The payment term (duration). */
text?: string;
/** 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. */
/** 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. */
text_normalized?: string;
/** The details of the normalized text, if applicable. This element is optional; that is, the service output lists it only if normalized text exists. */
/** The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists. */
interpretation?: Interpretation;
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
/** Hashed values that you can send to IBM to provide feedback or receive support. */
provenance_ids?: string[];
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
location?: Location;
}

/** An array of values, each being the `id` value of a row header that is applicable to this body cell. */
export interface RowHeaderIds {
/** The `id` values of a row header. */
id?: string;
}

/** An array of values, each being the `text` value of a row header that is applicable to this body cell. */
export interface RowHeaderTexts {
/** The `text` value of a row header. */
text?: string;
}

/** 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`. */
export interface RowHeaderTextsNormalized {
/** The normalized version of a row header text. */
text_normalized?: string;
}

/** Row-level cells, each applicable as a header to other cells in the same row as itself, of the current table. */
export interface RowHeaders {
/** The unique ID of the cell in the current table. */
Expand Down Expand Up @@ -1954,9 +1940,9 @@ namespace CompareComplyV1 {
confidence_level?: string;
/** The termination date. */
text?: string;
/** 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. */
/** 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. */
text_normalized?: string;
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
/** Hashed values that you can send to IBM to provide feedback or receive support. */
provenance_ids?: string[];
/** The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`. */
location?: Location;
Expand All @@ -1966,7 +1952,7 @@ namespace CompareComplyV1 {
export interface TypeLabel {
/** 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. */
label?: Label;
/** One or more hash values that you can send to IBM to provide feedback or receive support. */
/** Hashed values that you can send to IBM to provide feedback or receive support. */
provenance_ids?: string[];
}

Expand Down
2 changes: 1 addition & 1 deletion test/unit/assistant.v1.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2019 IBM All Rights Reserved.
* (C) Copyright IBM Corp. 2018, 2019.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion test/unit/compare-comply.v1.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2019 IBM All Rights Reserved.
* (C) Copyright IBM Corp. 2018, 2019.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion test/unit/discovery.v1.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2019 IBM All Rights Reserved.
* (C) Copyright IBM Corp. 2018, 2019.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion test/unit/language-translator.v3.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2019 IBM All Rights Reserved.
* (C) Copyright IBM Corp. 2018, 2019.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion test/unit/natural-language-classifier.v1.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2019 IBM All Rights Reserved.
* (C) Copyright IBM Corp. 2018, 2019.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion test/unit/natural-language-understanding.v1.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2019 IBM All Rights Reserved.
* (C) Copyright IBM Corp. 2018, 2019.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion test/unit/speech-to-text.v1.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2019 IBM All Rights Reserved.
* (C) Copyright IBM Corp. 2018, 2019.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion test/unit/text-to-speech.v1.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2019 IBM All Rights Reserved.
* (C) Copyright IBM Corp. 2018, 2019.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion test/unit/visual-recognition.v3.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright 2019 IBM All Rights Reserved.
* (C) Copyright IBM Corp. 2018, 2019.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down

0 comments on commit 132ad09

Please sign in to comment.