@planet-a/affinity-node - npm Package Compare versions

Comparing version 0.0.1-test.18 to 0.0.1-test.19

esm/v1/index.js

@@ -11,2 +11,3 @@ import axios from 'axios';
 import { EntityFiles } from './entity_files.js';
+import { Notes } from './notes.js';
 export { EntityType, FieldValueType, RoleId } from './lists.js';
@@ -85,2 +86,8 @@ export { AffinityApiError } from './errors.js';
         });
+        Object.defineProperty(this, "notes", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.axios = axiosInstance || axios.create();
@@ -103,3 +110,4 @@ this.axios.defaults.headers.common['X-Requested-With'] =
         this.entityFiles = new EntityFiles(this.axios);
+        this.notes = new Notes(this.axios);
     }
 }

esm/v1/persons.js

@@ -70,3 +70,3 @@ import { defaultTransformers } from './axios_default_transformers.js';
     /**
-     * Fetches an person with a specified `person_id`.
+     * Fetches a person with a specified `person_id`.
      *
@@ -161,3 +161,3 @@ * @returns The person object corresponding to the `person_id`.
      *
-     * @param data - Object containing the data for updating an person
+     * @param data - Object containing the data for updating a person
      * @returns The person resource that was just updated.
@@ -181,3 +181,3 @@ *
     /**
-     * Deletes an person with a specified `person_id`.
+     * Deletes a person with a specified `person_id`.
      * @returns true if the deletion was successful
@@ -184,0 +184,0 @@ *

esm/v1/urls.js

@@ -78,1 +78,8 @@ /**
 };
+/**
+ * @hidden
+ * See [here](https://api-docs.affinity.co/#notes) for more info.
+ */
+export const notesUrl = (note_id) => {
+    return note_id ? `/notes/${encodeURIComponent(note_id)}` : '/notes';
+};

package.json

 {
   "name": "@planet-a/affinity-node",
-  "version": "0.0.1-test.18",
+  "version": "0.0.1-test.19",
   "description": "API wrapper for the affinity.co API",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -40,3 +40,3 @@ # [![Test, Lint & Deploy](https://github.com/planet-a-ventures/affinity-node/actions/workflows/main.yml/badge.svg)](https://github.com/planet-a-ventures/affinity-node/actions/workflows/main.yml) [![NPM Version](https://img.shields.io/npm/v/%40planet-a%2Faffinity-node)](https://www.npmjs.com/package/@planet-a/affinity-node) affinity-node
 - ❌ Relationship Strengths
-- ❌ Notes
+- ✅ [Notes](src/v1/notes.ts)
 - ✅ [Entity Files](src/v1/entity_files.ts)
@@ -43,0 +43,0 @@ - ❌ Reminders

types/v1/entity_files.d.ts

@@ -34,3 +34,3 @@ /// <reference types="node" />
  */
-export type AllEntityFileRequest = {
+export type AllEntityFileRequest = PagedRequest | (RequireOnlyOne<{
     /**
@@ -48,3 +48,3 @@ * A unique ID that represents a Person whose associated files should be retrieved.
     opportunity_id?: number;
-} & PagedRequest;
+}> & PagedRequest);
 export type PagedEntityFileResponseRaw = {
@@ -59,3 +59,3 @@ entity_files: EntityFileRaw[];
     files: SupportedFileType[];
-} & RequireOnlyOne<EntityRequestFilter, keyof EntityRequestFilter>;
+} & RequireOnlyOne<EntityRequestFilter>;
 /**
@@ -62,0 +62,0 @@ * Entity files are files uploaded to a relevant entity.

types/v1/field_value_changes.d.ts

@@ -108,3 +108,3 @@ import type { AxiosInstance } from 'axios';
 };
-export type GetFieldValueChangesRequest = GetFieldValueChangesRequestBase | (GetFieldValueChangesRequestBase & RequireOnlyOne<GetFieldValueChangesRequestFilter, keyof GetFieldValueChangesRequestFilter>);
+export type GetFieldValueChangesRequest = GetFieldValueChangesRequestBase | (GetFieldValueChangesRequestBase & RequireOnlyOne<GetFieldValueChangesRequestFilter>);
 /**
@@ -111,0 +111,0 @@ * Field value changes allow you to see historical changes to the values of fields in Affinity.

types/v1/index.d.ts

@@ -11,2 +11,3 @@ import { type AxiosInstance } from 'axios';
 import { EntityFiles } from './entity_files.js';
+import { Notes } from './notes.js';
 export type * as ListEntries from './list_entries.js';
@@ -22,2 +23,3 @@ export type * as Lists from './lists.js';
 export type * as EntityFiles from './entity_files.js';
+export type * as Notes from './notes.js';
 export { EntityType, FieldValueType, RoleId } from './lists.js';
@@ -47,2 +49,3 @@ export { AffinityApiError } from './errors.js';
     readonly entityFiles: EntityFiles;
+    readonly notes: Notes;
 }

types/v1/persons.d.ts

@@ -146,3 +146,3 @@ import type { AxiosInstance } from 'axios';
     /**
-     * Fetches an person with a specified `person_id`.
+     * Fetches a person with a specified `person_id`.
      *
@@ -220,3 +220,3 @@ * @returns The person object corresponding to the `person_id`.
      *
-     * @param data - Object containing the data for updating an person
+     * @param data - Object containing the data for updating a person
      * @returns The person resource that was just updated.
@@ -236,3 +236,3 @@ *
     /**
-     * Deletes an person with a specified `person_id`.
+     * Deletes a person with a specified `person_id`.
      * @returns true if the deletion was successful
@@ -239,0 +239,0 @@ *

types/v1/types.d.ts

@@ -14,1 +14,4 @@ /**
 }[Keys];
+export type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+}[Keys];

types/v1/urls.d.ts

@@ -61,1 +61,6 @@ /**
 export declare const entityFilesUrl: (entity_file_id?: number, is_download?: boolean) => string;
+/**
+ * @hidden
+ * See [here](https://api-docs.affinity.co/#notes) for more info.
+ */
+export declare const notesUrl: (note_id?: number) => string;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

263166

increased by7.18%

Number of package files

126

increased by1.61%

Lines of code

7210

increased by7.18%

No dependency changes