@veryfi/veryfi-sdk 1.1.4 → 1.1.5

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 (10) hide show
  1. package/package.json +6 -1
  2. package/.github/workflows/node.js.yml +0 -31
  3. package/test/deleteDocument.json +0 -4
  4. package/test/getDocument.json +0 -111
  5. package/test/getDocuments.json +0 -3509
  6. package/test/main.test.js +0 -161
  7. package/test/processDocument.json +0 -153
  8. package/test/processDocumentUrl.json +0 -183
  9. package/test/receipt.png +0 -0
  10. package/test/updateDocument.json +0 -255
package/test/main.test.js DELETED
@@ -1,161 +0,0 @@
1
- /**
2
- * Test main functions and input parameters
3
- */
4
-
5
- const Client = require('../lib/main');
6
- const fs = require('fs');
7
- const client_id = 'YOUR_ID';
8
- const client_secret = 'YOUR_SECRET';
9
- const username = 'YOUR_USERNAME';
10
- const api_key = 'YOUR_API_KEY';
11
-
12
- let doc_id = 'ID_TO_MODIFY';
13
- let delete_id = 'ID_TO_DELETE';
14
-
15
- let mockResponses = true; // Change to “false” if you want to test your personal credentials
16
-
17
-
18
- //Creating the Client
19
- let veryfi_client = new Client(client_id, client_secret, username, api_key);
20
-
21
- describe('Processing documents', () => {
22
- jest.setTimeout(10000)
23
- test('Upload invoice for processing', async () => {
24
- try {
25
- let response;
26
- if (mockResponses) {
27
- const processDocumentJson = require('./processDocument.json');
28
- const veryfi_process_document = jest.fn();
29
- veryfi_process_document.mockReturnValue(processDocumentJson);
30
- response = veryfi_process_document();
31
- } else {
32
- response = await veryfi_client.process_document('test/receipt.png');
33
- }
34
- expect(response['vendor']['name']).toBe('The Home Depot');
35
- } catch (error) {
36
- throw new Error(error);
37
- }
38
- });
39
-
40
- test('Process document from buffer', async () => {
41
- try {
42
- let response;
43
- if (mockResponses) {
44
- const processDocumentJson = require('./processDocument.json');
45
- const process_document_buffer = jest.fn();
46
- process_document_buffer.mockReturnValue(processDocumentJson);
47
- response = process_document_buffer();
48
- } else {
49
- const file_path = 'test/receipt.png';
50
- const image_file = fs.readFileSync(file_path, { encoding: 'base64' });
51
- const base64_encoded_string = Buffer.from(image_file).toString('utf-8');
52
- response = await veryfi_client.process_document_buffer(
53
- base64_encoded_string,
54
- 'receipt.png'
55
- );
56
- }
57
- expect(response['vendor']['name']).toBe('The Home Depot');
58
- } catch (error) {
59
- throw new Error(error);
60
- }
61
- });
62
-
63
- test('Process document from URL', async () => {
64
- try {
65
- let response;
66
- if (mockResponses) {
67
- const processDocumentUrlJson = require('./processDocumentUrl.json');
68
- const veryfi_process_document_url = jest.fn();
69
- veryfi_process_document_url.mockReturnValue(processDocumentUrlJson);
70
- response = veryfi_process_document_url();
71
- } else {
72
- response = await veryfi_client.process_document_url('https://cdn.veryfi.com/receipts/92233902-c94a-491d-a4f9-0d61f9407cd2.pdf');
73
- }
74
- expect(response['vendor']['name']).toBe('Rumpke Waste & Recycling');
75
- } catch (error) {
76
- throw new Error(error);
77
- }
78
- });
79
- });
80
-
81
- describe('Managing documents', () => {
82
- test('Get documents', async () => {
83
- try {
84
- let docs;
85
- if (mockResponses) {
86
- const getDocumentsJson = require('./getDocuments.json');
87
- const veryfi_get_documents = jest.fn();
88
- veryfi_get_documents.mockReturnValue(getDocumentsJson);
89
- docs = veryfi_get_documents();
90
- } else {
91
- docs = await veryfi_client.get_documents();
92
- }
93
- expect(docs.length).toBeGreaterThan(0);
94
- expect(docs).toEqual(
95
- expect.arrayContaining([
96
- expect.objectContaining({
97
- 'id': expect.any(Number),
98
- 'category': expect.any(String)
99
- })
100
- ])
101
- );
102
- } catch (error) {
103
- throw new Error(error);
104
- }
105
- });
106
-
107
- test(`Get document with id ${doc_id}`, async () => {
108
- try {
109
- let doc;
110
- if (mockResponses) {
111
- doc_id = 31727276;
112
- const getDocumentJson = require('./getDocument.json');
113
- const veryfi_get_document = jest.fn();
114
- veryfi_get_document.mockReturnValue(getDocumentJson);
115
- doc = veryfi_get_document();
116
- } else {
117
- doc = await veryfi_client.get_document(doc_id);
118
- }
119
- expect(doc['id']).toBe(doc_id)
120
- } catch (error) {
121
- throw new Error(error);
122
- }
123
- });
124
- });
125
-
126
- describe('Editing Documents', () => {
127
- test('Update a document\'s entries', async () => {
128
- let params = {'notes':'Note updated'};
129
- try {
130
- let response;
131
- if (mockResponses) {
132
- const updateDocumentJson = require('./updateDocument.json');
133
- const veryfi_update_document = jest.fn();
134
- veryfi_update_document.mockReturnValue(updateDocumentJson);
135
- response = veryfi_update_document();
136
- } else {
137
- response = await veryfi_client.update_document(doc_id, params);
138
- }
139
- expect(response).toEqual(expect.objectContaining(params));
140
- } catch (error) {
141
- throw new Error(error);
142
- }
143
- });
144
-
145
- test('Delete a document by id', async () => {
146
- try {
147
- let response;
148
- if (mockResponses) {
149
- const deleteDocumentJson = require('./deleteDocument.json');
150
- const veryfi_delete_document = jest.fn();
151
- veryfi_delete_document.mockReturnValue(deleteDocumentJson);
152
- response = veryfi_delete_document();
153
- } else {
154
- response = await veryfi_client.delete_document(delete_id);
155
- }
156
- expect(response['status']).toBe('ok')
157
- } catch (error) {
158
- throw new Error(error);
159
- }
160
- });
161
- })
package/test/processDocument.json DELETED
@@ -1,153 +0,0 @@
1
- {
2
- "abn_number":"",
3
- "account_number":"",
4
- "barcodes":[
5
-
6
- ],
7
- "bill_to_address":"",
8
- "bill_to_name":"",
9
- "card_number":"7373",
10
- "category":"",
11
- "created":"2021-07-22 02:50:23",
12
- "currency_code":"COP",
13
- "date":"2018-10-17 09:03:00",
14
- "delivery_date":"",
15
- "discount":0.0,
16
- "document_title":"",
17
- "document_type":"receipt",
18
- "due_date":"",
19
- "external_id":"",
20
- "id":38232288,
21
- "img_file_name":"b65468f7-80bf-4cac-8706-96ed46f78540.png",
22
- "img_thumbnail_url":"https://scdn.veryfi.com/receipts/4dc81063-61ff-481a-90ee-473e46228cce/b65468f7-80bf-4cac-8706-96ed46f78540_t.png?Expires=1626923123&Signature=Ch2Jzr9S2T64LegBHCPewjrzGxItTI7LUB1jM3SKfECyvcnmqhsg9rOxVhGq4JvPvW7rhGcwxLAHEyBbrPRm0P9UZodDRF3K2BYuKpHnZ1p38oqgtOKqOKNeoOdLzrL2LC8wn2B96Cb~uzjlr0J1TZRuLqBojiwcta-9xEuooVKilPLzNoC3dtsZ2YdxxG50hpHTCUW2JPNr~YdAmR6651A~leYUIxjnukxTc6J0a4YYaWq611wShQvmiVx1n5UhF7ENbvN45FKLcKH4HZQMPibQmVl56BSd8aEBwWSKbbvE1RVPLJOkqcA9gIGrMbz4YVVG2iScaUQppZ0VvVHj4Q__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
23
- "img_url":"https://scdn.veryfi.com/receipts/4dc81063-61ff-481a-90ee-473e46228cce/b65468f7-80bf-4cac-8706-96ed46f78540.png?Expires=1626923123&Signature=WYdZ~o9YPVQ4ZdPWFi04TfMkFeG8vv~4w0KROPaa8E-8cfrCcglmYbaOIM8nV~Zyem26zIgIQlwaa2CtcvIC9BCe2wVQDDddoCAEm3C6VuLHFXMD9HTVNEnrs~rY6jont26KragwOtc7uUxaqpFmRwItbJjU1T78rHMtcoF9witqEP0XDi1fEX5Tw64Y2-NVDwy72s8bpdWYXZ2pQB8uki6DiSXr99Z6TFNeVQoJGCVYWMmWx7kNTklEtzxea125IOGnHpE7GH9qH0Z4N9ZPim7cTGMImR6gZj-cl~QiViDKf0reZrEEvRx6fDV0lBYof71F1xWD8a3IuiJiqnOMaw__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
24
- "incoterms":"",
25
- "insurance":"",
26
- "invoice_number":"17717",
27
- "is_document":1,
28
- "is_money_in":0,
29
- "line_items":[
30
- {
31
- "date":"",
32
- "description":"SNIP LEFT <A>\nWISS LEFT-CUT SNIPS",
33
- "discount":4.0,
34
- "id":72555673,
35
- "order":0,
36
- "price":0.0,
37
- "quantity":1.0,
38
- "reference":"",
39
- "section":"",
40
- "sku":"037103136480",
41
- "tax":0.0,
42
- "tax_rate":0.0,
43
- "total":9.97,
44
- "type":"product",
45
- "unit_of_measure":"",
46
- "weight":""
47
- },
48
- {
49
- "date":"",
50
- "description":"MILW5PCKBLDG <A>\nMKE 5PK GENERAL PURPOSE BLADES",
51
- "discount":0.0,
52
- "id":72555674,
53
- "order":1,
54
- "price":0.0,
55
- "quantity":1.0,
56
- "reference":"",
57
- "section":"",
58
- "sku":"045242268061",
59
- "tax":0.0,
60
- "tax_rate":0.0,
61
- "total":1.18,
62
- "type":"product",
63
- "unit_of_measure":"",
64
- "weight":""
65
- },
66
- {
67
- "date":"",
68
- "description":"1LB. SCREW <A>\nEB NEO SELF-DRILLING 12X1",
69
- "discount":0.0,
70
- "id":72555675,
71
- "order":2,
72
- "price":0.0,
73
- "quantity":1.0,
74
- "reference":"",
75
- "section":"",
76
- "sku":"038902058966",
77
- "tax":0.0,
78
- "tax_rate":0.0,
79
- "total":10.57,
80
- "type":"product",
81
- "unit_of_measure":"",
82
- "weight":""
83
- },
84
- {
85
- "date":"",
86
- "description":"1LB. SCREW <A>\nEB NEO SELF-DRILLING 12X3/4",
87
- "discount":0.0,
88
- "id":72555676,
89
- "order":3,
90
- "price":0.0,
91
- "quantity":1.0,
92
- "reference":"",
93
- "section":"",
94
- "sku":"038902058959",
95
- "tax":0.0,
96
- "tax_rate":0.0,
97
- "total":10.57,
98
- "type":"product",
99
- "unit_of_measure":"",
100
- "weight":""
101
- }
102
- ],
103
- "notes":"",
104
- "ocr_text":"HOME\nTHE\n\tMore saving.\n® More doing.\"\n2250 SOUTHGATE RD, COLORADO SPRINGS, CO\nBECKY NATION STOREMANAGER 719-471-0054\n1518 00000 17717 10/17/18 09:03 AM\nSELF CHECK OUT\n037103136480 SNIP LEFT <A>\t9.97\nWISS LEFT-CUT SNIPS\nNLP Savings $4.00\n045242268061 MILW5PCKBLDG <A>\t1.18\nMKE 5PK GENERAL PURPOSE BLADES\n038902058966 1LB. SCREW <A>\t10.57\nEB NEO SELF-DRILLING 12X1\n038902058959 1LB. SCREW <A>\t10.57\nEB NEO SELF-DRILLING 12X3/4\nSUBTOTAL\t32.29\nSALES TAX\t2.66\nTOTAL\t$34.95\nXXXXXXXXXXXX7373 VISA\n\tUSD$ 34.95\nAUTH CODE 025972/8585391\tTA\nAID A0000003131010 43415050544140204F4\nE452050595341\nDEPOT",
105
- "order_date":"",
106
- "payment_display_name":"Visa ***7373",
107
- "payment_terms":"",
108
- "payment_type":"visa",
109
- "phone_number":"719-471-0054",
110
- "purchase_order_number":"",
111
- "reference_number":"VCACD-2288",
112
- "service_end_date":"",
113
- "service_start_date":"",
114
- "ship_date":"",
115
- "shipping":0.0,
116
- "subtotal":32.29,
117
- "tags":[
118
-
119
- ],
120
- "tax":2.66,
121
- "tax_lines":[
122
- {
123
- "base":0.0,
124
- "name":"SALES",
125
- "order":0,
126
- "rate":0.0,
127
- "total":2.66
128
- }
129
- ],
130
- "tip":0.0,
131
- "total":34.95,
132
- "total_weight":"",
133
- "tracking_number":"",
134
- "updated":"2021-07-22 02:50:24",
135
- "vat_number":"",
136
- "vendor":{
137
- "address":"2250 Southgate Rd, Colorado Springs, CO 80906, United States",
138
- "fax_number":"",
139
- "name":"The Home Depot",
140
- "phone_number":"719-471-0054",
141
- "raw_name":"Home Depot",
142
- "vendor_logo":"https://cdn.veryfi.com/logos/us/051435926.jpg",
143
- "vendor_type":"hardware store"
144
- },
145
- "vendor_account_number":"",
146
- "vendor_bank_name":"",
147
- "vendor_bank_number":"",
148
- "vendor_bank_swift":"",
149
- "vendor_iban":"",
150
- "warnings":[
151
-
152
- ]
153
- }
package/test/processDocumentUrl.json DELETED
@@ -1,183 +0,0 @@
1
- {
2
- "abn_number":"",
3
- "account_number":"1234987650",
4
- "barcodes":[
5
-
6
- ],
7
- "bill_to_address":"1234 CUSTOMER AVE\nCLEVELAND OH 44114",
8
- "bill_to_name":"JOHN DOE",
9
- "card_number":"",
10
- "category":"",
11
- "created":"2021-07-22 02:46:28",
12
- "currency_code":"COP",
13
- "date":"2020-08-04 00:00:00",
14
- "delivery_date":"",
15
- "discount":0.0,
16
- "document_title":"",
17
- "document_type":"invoice",
18
- "due_date":"2020-08-19",
19
- "external_id":"",
20
- "id":38232226,
21
- "img_file_name":"ac34009c-3eef-4bae-835b-3f289e4d6a86.pdf",
22
- "img_thumbnail_url":"https://scdn.veryfi.com/receipts/b76f2a94-d992-4780-87fa-1596d528de41/ac34009c-3eef-4bae-835b-3f289e4d6a86_t.jpg?Expires=1626922889&Signature=CsuxaxiuGIV6uxnZSYH6vZwNitwKwNdP0Rx7B0PJqmi~R2yFIUSVl~k4trI5BpRljw7~pVHAVdYSeqQ~S1lpstbmnisR-y2iEA-Ub~E87muOMjARxHmd8mEVaNrw30DrTHWXgJD4VXdX89mnju3M3d-O-trOeAO8doCX~b9~h9ABGxYIjDqvUkE6BELolkkwuj0XfKoIO9E6R9~aSxUHWdbRtwamJGyJYjuhRHMgCGqjsKmYsupglFlmP82t88aXCAYySGM5U8ldWxqVlqvMAdLFOYWs~EPBlWMKd2O1ExCBUUdi3pojPY13v1gdOlFB5LkRXW5vH-ginhmvUB4hOA__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
23
- "img_url":"https://scdn.veryfi.com/receipts/b76f2a94-d992-4780-87fa-1596d528de41/ac34009c-3eef-4bae-835b-3f289e4d6a86.pdf?Expires=1626922889&Signature=bpMBhGaqXXLBspCuiPQWfweqhe5rZaIH-Pjo4GKwP~gQp3YEe2aWlQcHgNbkm6sKP9nwJEL7m~HsJ1kp51pHLuoQNxANwFA1fqrwr~4stpga558a8lJnMUfmcPSWsgajkUpmbBUeAfiQWv3YjAiaU-~5yOs7BPbzkc~Ww79CUJE9amvtIwP1yT-yrbGk00rli6Vb-et5x2gxWRuaXtFUOe-PMyftaiIFxrYE1~9MWZcp27numMHo7wteUFAEDqFVnr17RnBhVVDZTn5F6GO7H7UjadlOfUkLqdYmlqTWQYzTwasaWZ0cd2cct551l9VRws0tiqgPHdgLBSRZHEz~lA__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
24
- "incoterms":"",
25
- "insurance":"",
26
- "invoice_number":"0998811",
27
- "is_document":1,
28
- "is_money_in":0,
29
- "line_items":[
30
- {
31
- "date":"2020-08-01",
32
- "description":"2YD FL/MONTH-MSW",
33
- "discount":0.0,
34
- "id":72555518,
35
- "order":0,
36
- "price":116.32,
37
- "quantity":1.0,
38
- "reference":"",
39
- "section":"",
40
- "sku":"",
41
- "tax":0.0,
42
- "tax_rate":0.0,
43
- "total":116.32,
44
- "type":"product",
45
- "unit_of_measure":"",
46
- "weight":""
47
- },
48
- {
49
- "date":"2020-08-01",
50
- "description":"FL CASTER SVC",
51
- "discount":0.0,
52
- "id":72555519,
53
- "order":1,
54
- "price":5.0,
55
- "quantity":2.0,
56
- "reference":"",
57
- "section":"",
58
- "sku":"",
59
- "tax":0.0,
60
- "tax_rate":0.0,
61
- "total":10.0,
62
- "type":"food",
63
- "unit_of_measure":"",
64
- "weight":""
65
- },
66
- {
67
- "date":"2020-08-01",
68
- "description":"FUEL SURCHARGE FL",
69
- "discount":0.0,
70
- "id":72555520,
71
- "order":2,
72
- "price":29.89,
73
- "quantity":1.0,
74
- "reference":"",
75
- "section":"",
76
- "sku":"",
77
- "tax":0.0,
78
- "tax_rate":0.0,
79
- "total":29.89,
80
- "type":"fuel",
81
- "unit_of_measure":"",
82
- "weight":""
83
- },
84
- {
85
- "date":"2020-08-03",
86
- "description":"2YD FL/MONTH-MSW",
87
- "discount":0.0,
88
- "id":72555521,
89
- "order":3,
90
- "price":116.32,
91
- "quantity":1.0,
92
- "reference":"",
93
- "section":"",
94
- "sku":"",
95
- "tax":0.0,
96
- "tax_rate":0.0,
97
- "total":116.32,
98
- "type":"product",
99
- "unit_of_measure":"",
100
- "weight":""
101
- },
102
- {
103
- "date":"2020-08-03",
104
- "description":"FL CASTER SVC",
105
- "discount":0.0,
106
- "id":72555522,
107
- "order":4,
108
- "price":5.0,
109
- "quantity":1.0,
110
- "reference":"",
111
- "section":"",
112
- "sku":"",
113
- "tax":0.0,
114
- "tax_rate":0.0,
115
- "total":5.0,
116
- "type":"product",
117
- "unit_of_measure":"",
118
- "weight":""
119
- },
120
- {
121
- "date":"2020-08-03",
122
- "description":"FUEL SURCHARGE FL",
123
- "discount":0.0,
124
- "id":72555523,
125
- "order":5,
126
- "price":28.74,
127
- "quantity":1.0,
128
- "reference":"",
129
- "section":"",
130
- "sku":"",
131
- "tax":0.0,
132
- "tax_rate":0.0,
133
- "total":28.74,
134
- "type":"fuel",
135
- "unit_of_measure":"",
136
- "weight":""
137
- }
138
- ],
139
- "notes":"",
140
- "ocr_text":"RUMPLE\n\tDate: 08/04/20 Page 1 of 1\n\tService Period: AUGUST\n\tFor Service & Billing Call\n3800 STRUBLE RD\t\t\t\t(800) 828-8171\nCINCINATTI OH 45251\t\t\t\tService Address:\nCustomer #:\t1234987650\t1234 CUSTOMER AVE\nAccess Code:\t515151515\tCLEVELAND OH 44114\n\tInvoice #:\t0998811\n\tInvoice Total:\t329.74\nJOHN DOE\t\t\t\tDue Date:\t08/19/20\n1234 CUSTOMER AVE\nCLEVELAND OH 44114\n\nDate\tDescription\t\tQty\tPrice\tTotal\n08/01/20\t2YD FL/MONTH-MSW\t1.00\t116.32\t116.32\n08/01/20\tFL CASTER SVC\t2.00\t5.00\t10.00\n08/01/20 FUEL SURCHARGE FL\t1.00\t29.89\t29.89\n08/03/20\t2YD FL/MONTH-MSW\t1.00\t116.32\t116.32\n08/03/20\tFL CASTER SVC\t\t1.00\t5.00\t5.00\n08/03/20\tFUEL SURCHARGE FL\t1.00\t28.74\t28.74\nTAXES:\t\t\t\t\t\t23.47\nTOTAL:\t\t\t\t\t\t329.74\n\nCurrent\tOver 30 Days\tOver 60 Days\tOver 90 Days\tUnapplied\n329.74\t329.74\t1.00\t1.00\t.00\nFOLD HERE\tAND THEN SEPARATE\tRETURN THIS PORTION WITH PAYMENT. DO NOT ATTACH CHECK TO STUB\nRUZZLE\nDate:\tCUSTOMER NUMBER\tINVOICE\tINVOICE AMOUNT\tDUE DATE\n08/04/20\t1234987650\t0998811\t329.74\t08/19/20\n\nRUMPKE OF OHIO INC\t\t\tJOHN DOE\nPO BOX 538710\t\t\t1234 CUSTOMER AVE\nCINCINNATI OH 45253-8710\t\tCLEVELAND OH 44114\n\n8438320082027800204160090135",
141
- "order_date":"",
142
- "payment_display_name":"",
143
- "payment_terms":"",
144
- "payment_type":"",
145
- "phone_number":"(800) 828-8171",
146
- "purchase_order_number":"",
147
- "reference_number":"VCACD-2226",
148
- "service_end_date":"",
149
- "service_start_date":"",
150
- "ship_date":"",
151
- "shipping":0.0,
152
- "subtotal":329.74,
153
- "tags":[
154
-
155
- ],
156
- "tax":23.47,
157
- "tax_lines":[
158
-
159
- ],
160
- "tip":0.0,
161
- "total":329.74,
162
- "total_weight":"",
163
- "tracking_number":"",
164
- "updated":"2021-07-22 02:46:29",
165
- "vat_number":"",
166
- "vendor":{
167
- "address":"3800 Struble Rd, Cincinnati, OH 45251, United States",
168
- "fax_number":"",
169
- "name":"Rumpke Waste & Recycling",
170
- "phone_number":"(800) 828-8171",
171
- "raw_name":"RUMPKE",
172
- "vendor_logo":"https://cdn.veryfi.com/logos/tmp/346683478.png",
173
- "vendor_type":"Utilities"
174
- },
175
- "vendor_account_number":"",
176
- "vendor_bank_name":"",
177
- "vendor_bank_number":"",
178
- "vendor_bank_swift":"",
179
- "vendor_iban":"",
180
- "warnings":[
181
-
182
- ]
183
- }
package/test/receipt.png DELETED
Binary file