@fenixalliance/abs-api-client 1.0.16 → 1.1.0

package/schemas/crmService/schema.s.ts

@@ -437,151 +437,83 @@ export interface paths {
       };
     };
   };
+  "/api/v2/CrmService/Contacts/{contactId}/Options": {
+    /**
+     * Retrieve a list of contact options
+     * @description Retrieve a list of options for a contact
+     */
+    get: operations["GetContactOptions"];
+    /**
+     * Create a new contact option
+     * @description Create a new option for a contact
+     */
+    post: operations["CreateContactOption"];
+  };
+  "/api/v2/CrmService/Contacts/{contactId}/Options/Count": {
+    /**
+     * Get the count of contact options
+     * @description Get the count of options for a contact
+     */
+    get: operations["GetContactOptionsCount"];
+  };
+  "/api/v2/CrmService/Contacts/{contactId}/Options/{optionId}": {
+    /**
+     * Retrieve a single contact option by its ID
+     * @description Retrieve a single contact option by its ID
+     */
+    get: operations["GetContactOptionById"];
+    /**
+     * Update a contact option
+     * @description Update a contact option
+     */
+    put: operations["UpdateContactOption"];
+    /**
+     * Delete a contact option
+     * @description Delete a contact option
+     */
+    delete: operations["DeleteContactOption"];
+  };
+  "/api/v2/CrmService/Contacts/{contactId}/Options/Key/{key}": {
+    /**
+     * Retrieve a single contact option by its key
+     * @description Retrieve a single contact option by its key
+     */
+    get: operations["GetContactOptionByKey"];
+  };
+  "/api/v2/CrmService/Contacts/{contactId}/Options/Upsert/{key}": {
+    /**
+     * Create or update a contact option by key
+     * @description Create or update a contact option by key
+     */
+    put: operations["UpsertContactOption"];
+  };
   "/api/v2/CrmService/Sync": {
-    post: {
-      parameters: {
-        query: {
-          tenantId: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["Envelope"];
-            "application/xml": components["schemas"]["Envelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Sync the current user into the current tenant's contact list
+     * @description Synchronizes the currently authenticated user into the current tenant's CRM contact list.
+     */
+    post: operations["SyncCurrentHolderToCurrentTenantCrm"];
   };
   "/api/v2/CrmService/Sync/Me": {
-    post: {
-      parameters: {
-        query: {
-          tenantId: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["Envelope"];
-            "application/xml": components["schemas"]["Envelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Sync the current user into a tenant's contact list
+     * @description Synchronizes the currently authenticated user into the specified tenant's CRM contact list.
+     */
+    post: operations["SyncCurrentHolderToTenantCrm"];
   };
   "/api/v2/CrmService/Sync/User": {
-    post: {
-      parameters: {
-        query: {
-          tenantId: string;
-          relatedUserId: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["Envelope"];
-            "application/xml": components["schemas"]["Envelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Sync a user into a tenant's contact list
+     * @description Synchronizes a specified user into the tenant's CRM contact list.
+     */
+    post: operations["SyncHolderToTenantCrmAsync"];
   };
   "/api/v2/CrmService/Sync/Tenant": {
-    post: {
-      parameters: {
-        query: {
-          tenantId: string;
-          relatedTenantId: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["EmptyEnvelope"];
-            "application/xml": components["schemas"]["EmptyEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Sync a tenant into another tenant's contact list
+     * @description Synchronizes a tenant into another tenant's CRM contact list.
+     */
+    post: operations["SyncTenantToTenantCrm"];
   };
 }
 
@@ -669,11 +601,12 @@ export interface components {
       linkedInUrl?: string | null;
       instagramUrl?: string | null;
       githubUsername?: string | null;
-      instagramUsername?: unknown;
-      tikTokUsername?: unknown;
-      stackExchangeUrl?: unknown;
-      stackOverflowUrl?: unknown;
-      parentContactId?: unknown;
+      instagramUsername?: string | null;
+      tikTokUsername?: string | null;
+      stackExchangeUrl?: string | null;
+      stackOverflowUrl?: string | null;
+      parentContactId?: string | null;
+      faxNumber?: string | null;
     };
     ContactDto: {
       id?: string | null;
@@ -835,9 +768,11 @@ export interface components {
       jobTitle?: string | null;
       countryId?: string | null;
       parentContactId?: string | null;
+      addressLine1?: string | null;
+      addressLine2?: string | null;
+      postalCode?: string | null;
       stateId?: string | null;
       cityId?: string | null;
-      postalCode?: string | null;
       streetLine1?: string | null;
       streetLine2?: string | null;
       currencyId?: string | null;
@@ -846,20 +781,20 @@ export interface components {
       coverUrl?: string | null;
       githubUsername?: string | null;
       instagramUsername?: string | null;
+      webUrl?: string | null;
       twitchUrl?: string | null;
       redditUrl?: string | null;
       gitHubUrl?: string | null;
-      githubUrl?: string | null;
       tikTokUrl?: string | null;
       twitterUrl?: string | null;
       youTubeUrl?: string | null;
-      websiteUrl?: string | null;
       facebookUrl?: string | null;
       linkedInUrl?: string | null;
       instagramUrl?: string | null;
       tikTokUsername?: string | null;
       stackExchangeUrl?: string | null;
       stackOverflowUrl?: string | null;
+      faxNumber?: string | null;
     };
     EmailDispatchRequest: {
       title: string;
@@ -1029,6 +964,16 @@ export interface components {
       email: string | null;
       isEmailConfirmed: boolean;
     };
+    Int32Envelope: {
+      isSuccess?: boolean;
+      errorMessage?: string | null;
+      correlationId?: string | null;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      /** Format: int32 */
+      result?: number;
+    };
     LoginRequest: {
       email: string | null;
       password: string | null;
@@ -1043,6 +988,61 @@ export interface components {
       from?: string | null;
       value?: unknown;
     };
+    OptionCreateDto: {
+      /** Format: uuid */
+      id?: string;
+      /** Format: date-time */
+      timestamp?: string;
+      key: string;
+      value: string;
+      portalId?: string | null;
+      frozen?: boolean;
+      autoload?: boolean;
+      transient?: boolean;
+      /** Format: int32 */
+      expiration?: number;
+    };
+    OptionDto: {
+      id?: string | null;
+      /** Format: date-time */
+      timestamp?: string | null;
+      key?: string | null;
+      value?: string | null;
+      portalId?: string | null;
+      frozen?: boolean;
+      autoload?: boolean;
+      transient?: boolean;
+      /** Format: int32 */
+      expiration?: number;
+    };
+    OptionDtoEnvelope: {
+      isSuccess?: boolean;
+      errorMessage?: string | null;
+      correlationId?: string | null;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      result?: components["schemas"]["OptionDto"];
+    };
+    OptionDtoListEnvelope: {
+      isSuccess?: boolean;
+      errorMessage?: string | null;
+      correlationId?: string | null;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      result?: components["schemas"]["OptionDto"][] | null;
+    };
+    OptionUpdateDto: {
+      key?: string | null;
+      value?: string | null;
+      portalId?: string | null;
+      frozen?: boolean;
+      autoload?: boolean;
+      transient?: boolean;
+      /** Format: int32 */
+      expiration?: number;
+    };
     RefreshRequest: {
       refreshToken: string | null;
     };
@@ -2515,4 +2515,515 @@ export interface operations {
       };
     };
   };
+  /**
+   * Retrieve a list of contact options
+   * @description Retrieve a list of options for a contact
+   */
+  GetContactOptions: {
+    parameters: {
+      query: {
+        tenantId: string;
+        portalId?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        contactId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["OptionDtoListEnvelope"];
+          "application/xml": components["schemas"]["OptionDtoListEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Create a new contact option
+   * @description Create a new option for a contact
+   */
+  CreateContactOption: {
+    parameters: {
+      query: {
+        tenantId: string;
+        key: string;
+        portalId?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        contactId: string;
+      };
+    };
+    requestBody?: {
+      content: {
+        "application/json": components["schemas"]["OptionCreateDto"];
+        "application/xml": components["schemas"]["OptionCreateDto"];
+      };
+    };
+    responses: {
+      /** @description Created */
+      201: {
+        content: {
+          "application/json": components["schemas"]["EmptyEnvelope"];
+          "application/xml": components["schemas"]["EmptyEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Get the count of contact options
+   * @description Get the count of options for a contact
+   */
+  GetContactOptionsCount: {
+    parameters: {
+      query: {
+        tenantId: string;
+        portalId?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        contactId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Int32Envelope"];
+          "application/xml": components["schemas"]["Int32Envelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Retrieve a single contact option by its ID
+   * @description Retrieve a single contact option by its ID
+   */
+  GetContactOptionById: {
+    parameters: {
+      query: {
+        tenantId: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        contactId: string;
+        optionId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["OptionDtoEnvelope"];
+          "application/xml": components["schemas"]["OptionDtoEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Update a contact option
+   * @description Update a contact option
+   */
+  UpdateContactOption: {
+    parameters: {
+      query: {
+        tenantId: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        contactId: string;
+        optionId: string;
+      };
+    };
+    requestBody?: {
+      content: {
+        "application/json": components["schemas"]["OptionUpdateDto"];
+        "application/xml": components["schemas"]["OptionUpdateDto"];
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["EmptyEnvelope"];
+          "application/xml": components["schemas"]["EmptyEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Delete a contact option
+   * @description Delete a contact option
+   */
+  DeleteContactOption: {
+    parameters: {
+      query: {
+        tenantId: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        contactId: string;
+        optionId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["EmptyEnvelope"];
+          "application/xml": components["schemas"]["EmptyEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Retrieve a single contact option by its key
+   * @description Retrieve a single contact option by its key
+   */
+  GetContactOptionByKey: {
+    parameters: {
+      query: {
+        tenantId: string;
+        portalId?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        contactId: string;
+        key: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["OptionDtoEnvelope"];
+          "application/xml": components["schemas"]["OptionDtoEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Create or update a contact option by key
+   * @description Create or update a contact option by key
+   */
+  UpsertContactOption: {
+    parameters: {
+      query: {
+        tenantId: string;
+        portalId?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        contactId: string;
+        key: string;
+      };
+    };
+    requestBody?: {
+      content: {
+        "application/json": components["schemas"]["OptionUpdateDto"];
+        "application/xml": components["schemas"]["OptionUpdateDto"];
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["EmptyEnvelope"];
+          "application/xml": components["schemas"]["EmptyEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Sync the current user into the current tenant's contact list
+   * @description Synchronizes the currently authenticated user into the current tenant's CRM contact list.
+   */
+  SyncCurrentHolderToCurrentTenantCrm: {
+    parameters: {
+      query: {
+        tenantId: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Envelope"];
+          "application/xml": components["schemas"]["Envelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Sync the current user into a tenant's contact list
+   * @description Synchronizes the currently authenticated user into the specified tenant's CRM contact list.
+   */
+  SyncCurrentHolderToTenantCrm: {
+    parameters: {
+      query: {
+        tenantId: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Envelope"];
+          "application/xml": components["schemas"]["Envelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Sync a user into a tenant's contact list
+   * @description Synchronizes a specified user into the tenant's CRM contact list.
+   */
+  SyncHolderToTenantCrmAsync: {
+    parameters: {
+      query: {
+        tenantId: string;
+        relatedUserId: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Envelope"];
+          "application/xml": components["schemas"]["Envelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Sync a tenant into another tenant's contact list
+   * @description Synchronizes a tenant into another tenant's CRM contact list.
+   */
+  SyncTenantToTenantCrm: {
+    parameters: {
+      query: {
+        tenantId: string;
+        relatedTenantId: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["EmptyEnvelope"];
+          "application/xml": components["schemas"]["EmptyEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
 }