@3wks/sargon-api-node-client - npm Package Compare versions

Comparing version 0.1.7 to 0.1.10

dist/api.d.ts

@@ -71,2 +71,88 @@ /**
  * @export
+ * @interface Activity
+ */
+export interface Activity {
+    /**
+     * The Universally Unqiue Resource Identifier (UUID) for this Resource.
+     * @type {string}
+     * @memberof Activity
+     */
+    id: string;
+    /**
+     * Internal event type of this event.
+     * @type {string}
+     * @memberof Activity
+     */
+    eventCode?: string;
+    /**
+     * Timestamp of when this event was initiated.
+     * @type {Date}
+     * @memberof Activity
+     */
+    timeStart?: Date;
+    /**
+     * Timestamp of when this event was completed.
+     * @type {Date}
+     * @memberof Activity
+     */
+    timeComplete?: Date;
+    /**
+     * Timestamp of when this event takes effect.
+     * @type {Date}
+     * @memberof Activity
+     */
+    effectiveDate?: Date;
+    /**
+     * Status of this event
+     * @type {string}
+     * @memberof Activity
+     */
+    status: Activity.StatusEnum;
+    /**
+     * Description of this event
+     * @type {string}
+     * @memberof Activity
+     */
+    description: string;
+    /**
+     * Indicator of how the event was initiated (by whom).
+     * @type {string}
+     * @memberof Activity
+     */
+    initiatedBy: Activity.InitiatedByEnum;
+    /**
+     * Array of Attachments attached to this event
+     * @type {Array<FileAttachment>}
+     * @memberof Activity
+     */
+    attachments?: Array<FileAttachment>;
+}
+/**
+ * @export
+ * @namespace Activity
+ */
+export declare namespace Activity {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum StatusEnum {
+        Pending = "Pending",
+        Complete = "Complete",
+        Failed = "Failed",
+        Error = "Error"
+    }
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum InitiatedByEnum {
+        Member = "Member",
+        Fund = "Fund",
+        Trustee = "Trustee"
+    }
+}
+/**
+ *
+ * @export
  * @interface Address
@@ -301,2 +387,66 @@ */
  * @export
+ * @interface Contact
+ */
+export interface Contact {
+    /**
+     *
+     * @type {Created}
+     * @memberof Contact
+     */
+    created?: Created;
+    /**
+     * A human readable description of this resource, subresource or link.
+     * @type {string}
+     * @memberof Contact
+     */
+    display?: string;
+    /**
+     *
+     * @type {Updated}
+     * @memberof Contact
+     */
+    updated?: Updated;
+    /**
+     * Primary Address
+     * @type {Address}
+     * @memberof Contact
+     */
+    address?: Address;
+    /**
+     * Contact Type
+     * @type {string}
+     * @memberof Contact
+     */
+    contactType?: Contact.ContactTypeEnum;
+    /**
+     * Contact Email Address
+     * @type {string}
+     * @memberof Contact
+     */
+    email?: string;
+    /**
+     * Contact Telephone Number
+     * @type {string}
+     * @memberof Contact
+     */
+    phone?: string;
+}
+/**
+ * @export
+ * @namespace Contact
+ */
+export declare namespace Contact {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum ContactTypeEnum {
+        Advisor = "Advisor",
+        Fund = "Fund",
+        Trustee = "Trustee"
+    }
+}
+/**
+ *
+ * @export
  * @interface Created
@@ -334,2 +484,45 @@ */
  * @export
+ * @interface FileAttachment
+ */
+export interface FileAttachment {
+    /**
+     * The Universally Unqiue Resource Identifier (UUID) for this Resource.
+     * @type {string}
+     * @memberof FileAttachment
+     */
+    id: string;
+    /**
+     *
+     * @type {Created}
+     * @memberof FileAttachment
+     */
+    created?: Created;
+    /**
+     * Name of the Attached File.
+     * @type {string}
+     * @memberof FileAttachment
+     */
+    fileName: string;
+    /**
+     * MIME Type of the Attached File.
+     * @type {string}
+     * @memberof FileAttachment
+     */
+    fileType: string;
+    /**
+     * Size (in bytes) of the Attached File.
+     * @type {number}
+     * @memberof FileAttachment
+     */
+    fileSize?: number;
+    /**
+     * URI to perform GET request to retrieve attachement.
+     * @type {string}
+     * @memberof FileAttachment
+     */
+    fileUri?: string;
+}
+/**
+ *
+ * @export
  * @interface Full
@@ -848,2 +1041,27 @@ */
 /**
+ *
+ * @export
+ * @interface MemberUpdate
+ */
+export interface MemberUpdate extends Member {
+    /**
+     * User Password.  If supplied in a request body, the user password will be changed. When changing a password the API MAY request an OTP challenge/response.
+     * @type {string}
+     * @memberof MemberUpdate
+     */
+    password?: string;
+    /**
+     * The Member's Tax Identifier. For Australia, this is the Tax File Number.  This value may be obsificated by the API.  In this case an asterisk will replace any masked characters.
+     * @type {string}
+     * @memberof MemberUpdate
+     */
+    taxId?: string;
+}
+/**
+ * @export
+ * @namespace MemberUpdate
+ */
+export declare namespace MemberUpdate {
+}
+/**
  * Preservation breakdown of the current balance
@@ -1188,2 +1406,11 @@ * @export
 }
+interface ListMemberContactsParams {
+    /**
+    * Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+    */
+    /**
+    * Filter by Contact Type
+    */
+    contactType?: 'Advisor' | 'Fund' | 'Trustee';
+}
 /**
@@ -1203,2 +1430,10 @@ * MembersApi - fetch parameter creator
     /**
+     * Return the full representation of the requested member by member UUID.  When accessed using member credentials the result is limited to the currently authenticated member.
+     * @summary Get Member
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMember(member: string, options?: Partial<Options>): Promise<FetchArgs>;
+    /**
      * Returns a paginated collection of accessible members.  The API may be configured to limit the resulting Members Collection to ensure that only minimal relevant data is exposed and only when required.  The Members Collection resource is subject to various limits and controls, these include:  * Request Rate Limiting * Result Limiting * Minimum Query Length  The date search feature searches on the member joinedDate attribute.
@@ -1210,2 +1445,27 @@ * @summary List Members
     getMembers(params?: GetMembersParams, options?: Partial<Options>): Promise<FetchArgs>;
+    /**
+     * List account activity for a Member resource.
+     * @summary List Account Activity
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMemberActivity(member: string, options?: Partial<Options>): Promise<FetchArgs>;
+    /**
+     * List contacts for a Member resource.
+     * @summary List Member Contacts
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMemberContacts(member: string, params?: ListMemberContactsParams, options?: Partial<Options>): Promise<FetchArgs>;
+    /**
+     * Update or perform an operation on a Member resource.  Once a member has been identity verified some attributes will become readOnly, these attributes are indicated with a `unverified` indicator.  However they may be updated in certain circumstances including:  * Self-serve with valid member credientials prior to the aquisition of a identity verification. * When accessed using fundOperator credentials and appropriate permissions.
+     * @summary Update Member
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {MemberUpdate} memberUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMember(member: string, memberUpdate: MemberUpdate, options?: Partial<Options>): Promise<FetchArgs>;
 };
@@ -1226,2 +1486,10 @@ /**
     /**
+     * Return the full representation of the requested member by member UUID.  When accessed using member credentials the result is limited to the currently authenticated member.
+     * @summary Get Member
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMember(member: string, options?: Partial<Options>): (fetch?: FetchAPI, basePath?: string) => Promise<Member>;
+    /**
      * Returns a paginated collection of accessible members.  The API may be configured to limit the resulting Members Collection to ensure that only minimal relevant data is exposed and only when required.  The Members Collection resource is subject to various limits and controls, these include:  * Request Rate Limiting * Result Limiting * Minimum Query Length  The date search feature searches on the member joinedDate attribute.
@@ -1233,2 +1501,27 @@ * @summary List Members
     getMembers(params?: GetMembersParams, options?: Partial<Options>): (fetch?: FetchAPI, basePath?: string) => Promise<MemberSummary[]>;
+    /**
+     * List account activity for a Member resource.
+     * @summary List Account Activity
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMemberActivity(member: string, options?: Partial<Options>): (fetch?: FetchAPI, basePath?: string) => Promise<Activity[]>;
+    /**
+     * List contacts for a Member resource.
+     * @summary List Member Contacts
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMemberContacts(member: string, params?: ListMemberContactsParams, options?: Partial<Options>): (fetch?: FetchAPI, basePath?: string) => Promise<Contact[]>;
+    /**
+     * Update or perform an operation on a Member resource.  Once a member has been identity verified some attributes will become readOnly, these attributes are indicated with a `unverified` indicator.  However they may be updated in certain circumstances including:  * Self-serve with valid member credientials prior to the aquisition of a identity verification. * When accessed using fundOperator credentials and appropriate permissions.
+     * @summary Update Member
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {MemberUpdate} memberUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMember(member: string, memberUpdate: MemberUpdate, options?: Partial<Options>): (fetch?: FetchAPI, basePath?: string) => Promise<Member>;
 };
@@ -1249,2 +1542,10 @@ /**
     /**
+     * Return the full representation of the requested member by member UUID.  When accessed using member credentials the result is limited to the currently authenticated member.
+     * @summary Get Member
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMember(member: string, options?: Partial<Options>): Promise<Member>;
+    /**
      * Returns a paginated collection of accessible members.  The API may be configured to limit the resulting Members Collection to ensure that only minimal relevant data is exposed and only when required.  The Members Collection resource is subject to various limits and controls, these include:  * Request Rate Limiting * Result Limiting * Minimum Query Length  The date search feature searches on the member joinedDate attribute.
@@ -1256,2 +1557,27 @@ * @summary List Members
     getMembers(params?: GetMembersParams, options?: Partial<Options>): Promise<MemberSummary[]>;
+    /**
+     * List account activity for a Member resource.
+     * @summary List Account Activity
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMemberActivity(member: string, options?: Partial<Options>): Promise<Activity[]>;
+    /**
+     * List contacts for a Member resource.
+     * @summary List Member Contacts
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMemberContacts(member: string, params?: ListMemberContactsParams, options?: Partial<Options>): Promise<Contact[]>;
+    /**
+     * Update or perform an operation on a Member resource.  Once a member has been identity verified some attributes will become readOnly, these attributes are indicated with a `unverified` indicator.  However they may be updated in certain circumstances including:  * Self-serve with valid member credientials prior to the aquisition of a identity verification. * When accessed using fundOperator credentials and appropriate permissions.
+     * @summary Update Member
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {MemberUpdate} memberUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMember(member: string, memberUpdate: MemberUpdate, options?: Partial<Options>): Promise<Member>;
 };
@@ -1275,2 +1601,11 @@ /**
     /**
+     * Return the full representation of the requested member by member UUID.  When accessed using member credentials the result is limited to the currently authenticated member.
+     * @summary Get Member
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MembersApi
+     */
+    getMember(member: string, options?: Partial<Options>): Promise<Member>;
+    /**
      * Returns a paginated collection of accessible members.  The API may be configured to limit the resulting Members Collection to ensure that only minimal relevant data is exposed and only when required.  The Members Collection resource is subject to various limits and controls, these include:  * Request Rate Limiting * Result Limiting * Minimum Query Length  The date search feature searches on the member joinedDate attribute.
@@ -1283,2 +1618,30 @@ * @summary List Members
     getMembers(params?: GetMembersParams, options?: Partial<Options>): Promise<MemberSummary[]>;
+    /**
+     * List account activity for a Member resource.
+     * @summary List Account Activity
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MembersApi
+     */
+    listMemberActivity(member: string, options?: Partial<Options>): Promise<Activity[]>;
+    /**
+     * List contacts for a Member resource.
+     * @summary List Member Contacts
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MembersApi
+     */
+    listMemberContacts(member: string, params?: ListMemberContactsParams, options?: Partial<Options>): Promise<Contact[]>;
+    /**
+     * Update or perform an operation on a Member resource.  Once a member has been identity verified some attributes will become readOnly, these attributes are indicated with a `unverified` indicator.  However they may be updated in certain circumstances including:  * Self-serve with valid member credientials prior to the aquisition of a identity verification. * When accessed using fundOperator credentials and appropriate permissions.
+     * @summary Update Member
+     * @param {string} member Unqiue UUID of the Member.  A value of \&quot;me\&quot; can be provided instead of a literal UUID.  \&quot;me\&quot; will be expanded to represent the currently authenticated member, if any.
+     * @param {MemberUpdate} memberUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MembersApi
+     */
+    updateMember(member: string, memberUpdate: MemberUpdate, options?: Partial<Options>): Promise<Member>;
 }
@@ -1285,0 +1648,0 @@ interface GetBalanceParams {

package.json

 {
   "name": "@3wks/sargon-api-node-client",
-  "version": "0.1.7",
+  "version": "0.1.10",
   "description": "OpenAPI client for @3wks/sargon-api-node-client",
@@ -5,0 +5,0 @@ "author": "OpenAPI-Generator Contributors",

README.md

@@ -1,2 +0,2 @@
-## @3wks/sargon-api-node-client@0.1.7
+## @3wks/sargon-api-node-client@0.1.10
 
@@ -39,3 +39,3 @@ This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 ```
-npm install @3wks/sargon-api-node-client@0.1.7 --save
+npm install @3wks/sargon-api-node-client@0.1.10 --save
 ```
@@ -42,0 +42,0 @@

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

242694

increased by39%

Lines of code

5852

increased by29.67%

Worsened metrics

Number of medium supply chain risk alerts

23

increased by53.33%

No dependency changes