@fenixalliance/abs-api-client 1.0.1 → 1.0.2

package/schemas/crmService/schema.s.ts

@@ -0,0 +1,804 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+
+export interface paths {
+  "/api/v2/CrmService/Contacts": {
+    /** Get all business owned contacts */
+    get: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to get the contacts for */
+          tenantId: string;
+          "api-version"?: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoListEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoListEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Contacts/{contactId}": {
+    /** Get a contact by ID */
+    get: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to get the contacts for */
+          tenantId: string;
+          "api-version"?: string;
+        };
+        path: {
+          contactId: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Contacts/Individuals": {
+    /** Get all contacts of type individual */
+    get: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to get the contacts for */
+          tenantId: string;
+          "api-version"?: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoListEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoListEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Contacts/Individual/{contactId}": {
+    /** Get a Contact of type Individual by ID. */
+    get: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to get the contact for */
+          tenantId: string;
+          "api-version"?: string;
+        };
+        path: {
+          contactId: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+        /** @description Not Found */
+        404: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Contacts/Organizations": {
+    /** Get all contacts of type organization */
+    get: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to get the contacts for */
+          tenantId: string;
+          "api-version"?: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoListEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoListEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Contacts/Organization/{contactId}": {
+    /** Get a Contact of type Organization by ID. */
+    get: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to get the contacts for */
+          tenantId: string;
+          "api-version"?: string;
+        };
+        path: {
+          contactId: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+        /** @description Not Found */
+        404: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Contacts/{contactId}/Cart": {
+    /** Get a contact's cart */
+    get: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to get the contacts for */
+          tenantId: string;
+          "api-version"?: string;
+        };
+        path: {
+          contactId: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["CartDtoEnvelope"];
+            "application/xml": components["schemas"]["CartDtoEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+        /** @description Not Found */
+        404: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Contacts/{contactId}/Wallet": {
+    /** Get a contact's wallet */
+    get: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to get the contacts for */
+          tenantId: string;
+          "api-version"?: string;
+        };
+        path: {
+          contactId: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["WalletDtoEnvelope"];
+            "application/xml": components["schemas"]["WalletDtoEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+        /** @description Not Found */
+        404: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Contacts/{contactId}/SocialProfile": {
+    /** Get a contact's social profile */
+    get: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to get the contacts for */
+          tenantId: string;
+          "api-version"?: string;
+        };
+        path: {
+          contactId: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["SocialProfileDtoEnvelope"];
+            "application/xml": components["schemas"]["SocialProfileDtoEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+        /** @description Not Found */
+        404: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Contacts/Organizations/Upsert": {
+    /** Upsert a tenant onto another tenant's contact list */
+    post: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to upsert the contact to */
+          tenantId: string;
+          /** @description The ID of the tenant to upsert */
+          relatedTenantId: string;
+          "api-version"?: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Contacts/Individuals/Upsert": {
+    /** Upsert a user onto a tenant's contact list */
+    post: {
+      parameters: {
+        query: {
+          /** @description The ID of the tenant to upsert the contact to */
+          tenantId: string;
+          /** @description The ID of the user to upsert */
+          relatedUserId: string;
+          "api-version"?: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Sync": {
+    /** Sync the current user into a tenant's contact list. */
+    post: {
+      parameters: {
+        query?: {
+          /** @description The id of the record owner tenant. */
+          tenantId?: string;
+          "api-version"?: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoListEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoListEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Sync/Me": {
+    /** Sync the user into a tenant's contact list. */
+    post: {
+      parameters: {
+        query: {
+          /** @description The id of the record owner tenant. */
+          tenantId: string;
+          "api-version"?: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoListEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoListEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Sync/User": {
+    /** Sync a user into a tenant's contact list. */
+    post: {
+      parameters: {
+        query: {
+          /** @description The id of the record owner tenant. */
+          tenantId: string;
+          /** @description The id of the user to sync against the owner tenant's contact list. */
+          relatedUserId: string;
+          "api-version"?: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ContactDtoListEnvelope"];
+            "application/xml": components["schemas"]["ContactDtoListEnvelope"];
+          };
+        };
+        /** @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"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/CrmService/Sync/Tenant": {
+    /** Sync a tenant into another tenant's contact list. */
+    post: {
+      parameters: {
+        query: {
+          /** @description The id of the record owner tenant. */
+          tenantId: string;
+          /** @description The id of the tenant to sync against the owner tenant's contact list. */
+          relatedTenantId: string;
+          "api-version"?: string;
+        };
+      };
+      responses: {
+        /** @description Success */
+        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"];
+          };
+        };
+      };
+    };
+  };
+}
+
+export type webhooks = Record<string, never>;
+
+export interface components {
+  schemas: {
+    CartDto: {
+      id?: string | null;
+      ip?: string | null;
+      type?: string | null;
+      /** Format: double */
+      total?: number;
+      /** Format: double */
+      taxes?: number;
+      /** Format: double */
+      freight?: number;
+      /** Format: double */
+      subTotal?: number;
+      currencyId?: string | null;
+      countryId?: string | null;
+      /** Format: int32 */
+      itemCartRecordsCount?: number | null;
+      /** Format: int32 */
+      itemToCompareRecordsCount?: number | null;
+    };
+    CartDtoEnvelope: {
+      errorMessage?: string | null;
+      isSuccess?: boolean;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      correlationId?: string | null;
+      result?: components["schemas"]["CartDto"];
+    };
+    ContactDto: {
+      id?: string | null;
+      /** Format: date-time */
+      timestamp?: string | null;
+      /**
+       * Format: int32
+       * @enum {integer}
+       */
+      type?: 0 | 1;
+      taxId?: string | null;
+      firstName?: string | null;
+      lastName?: string | null;
+      primaryContactId?: string | null;
+      qualifiedName?: string | null;
+      email?: string | null;
+      about?: string | null;
+      mobilePhone?: string | null;
+      businessPhone?: string | null;
+      avatar?: string | null;
+      jobTitle?: string | null;
+      avatarUrl?: string | null;
+      coverUrl?: string | null;
+      websiteUrl?: string | null;
+      facebookUrl?: string | null;
+      twitterUrl?: string | null;
+      youtubeUrl?: string | null;
+      linkedInUrl?: string | null;
+      githubUsername?: string | null;
+      street?: string | null;
+      zipCode?: string | null;
+      cartId?: string | null;
+      walletId?: string | null;
+      cityId?: string | null;
+      countryStateId?: string | null;
+      countryId?: string | null;
+      languageId?: string | null;
+      currencyId?: string | null;
+      timezoneId?: string | null;
+      territoryId?: string | null;
+      enrollmentId?: string | null;
+      /** Format: double */
+      walletBalance?: number | null;
+      ownerContactId?: string | null;
+      ownerTenantId?: string | null;
+      relatedTenantId?: string | null;
+      activityFeedId?: string | null;
+      parentContactId?: string | null;
+      socialProfileId?: string | null;
+      activeDirectoryId?: string | null;
+      identityProvider?: string | null;
+      identityProviderAccessToken?: string | null;
+    };
+    ContactDtoEnvelope: {
+      errorMessage?: string | null;
+      isSuccess?: boolean;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      correlationId?: string | null;
+      result?: components["schemas"]["ContactDto"];
+    };
+    ContactDtoListEnvelope: {
+      errorMessage?: string | null;
+      isSuccess?: boolean;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      correlationId?: string | null;
+      result?: components["schemas"]["ContactDto"][] | null;
+    };
+    EmptyEnvelope: {
+      errorMessage?: string | null;
+      isSuccess?: boolean;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+    };
+    ErrorEnvelope: {
+      errorMessage?: string | null;
+      isSuccess?: boolean;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      correlationId?: string | null;
+    };
+    SocialProfileDto: {
+      id?: string | null;
+      /** Format: date-time */
+      timestamp?: string | null;
+      /**
+       * Format: int32
+       * @enum {integer}
+       */
+      type?: 0 | 1 | 2 | 3;
+      name?: string | null;
+      about?: string | null;
+      cover?: string | null;
+      avatar?: string | null;
+      country?: string | null;
+      /** Format: int32 */
+      followsCount?: number | null;
+      /** Format: int32 */
+      messagesCount?: number | null;
+      /** Format: int32 */
+      followersCount?: number | null;
+      /** Format: int32 */
+      notificationsCount?: number | null;
+      /** Format: int32 */
+      unreadNotificationsCount?: number | null;
+      /** Format: int32 */
+      unreadMessagesCount?: number | null;
+      socialFeedId?: string | null;
+      twitterUrl?: string | null;
+      facebookURL?: string | null;
+      linkedInURL?: string | null;
+      youtubeURL?: string | null;
+      githubURL?: string | null;
+      pinterestURL?: string | null;
+      dribbleURL?: string | null;
+      domain?: string | null;
+      notes?: string | null;
+    };
+    SocialProfileDtoEnvelope: {
+      errorMessage?: string | null;
+      isSuccess?: boolean;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      correlationId?: string | null;
+      result?: components["schemas"]["SocialProfileDto"];
+    };
+    WalletDto: {
+      id?: string | null;
+      /** Format: date-time */
+      timestamp?: string;
+      /** Format: double */
+      balance?: number;
+      /** Format: double */
+      cryptoBalance?: number;
+      testMode?: boolean;
+      verified?: boolean;
+      type?: string | null;
+      currencyId?: string | null;
+      /** Format: double */
+      forexRate?: number;
+      /** Format: double */
+      balanceInUsd?: number;
+      /** Format: double */
+      mainNetEtherBalance?: number;
+      ethereumAddress?: string | null;
+      ethereumPublicKey?: string | null;
+      ethereumPrivateKey?: string | null;
+      /** Format: double */
+      rollingReservePercent?: number;
+    };
+    WalletDtoEnvelope: {
+      errorMessage?: string | null;
+      isSuccess?: boolean;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      correlationId?: string | null;
+      result?: components["schemas"]["WalletDto"];
+    };
+  };
+  responses: never;
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+}
+
+export type $defs = Record<string, never>;
+
+export type external = Record<string, never>;
+
+export type operations = Record<string, never>;