fireberry-api-client 1.0.0-beta.2.3 → 1.0.0-beta.2.3.2

package/README.md

@@ -120,7 +120,20 @@ const result = await client.queryBuilder()
   .limit(50)
   .execute();
 
+// Query by ID - automatically uses correct field name for object type
+const account = await client.queryBuilder()
+  .objectType(1)
+  .whereId('abc123')  // Uses 'accountid' automatically
+  .execute();
+
+// Works with any object type
+const contact = await client.queryBuilder()
+  .objectType(2)
+  .whereId('xyz789')  // Uses 'contactid' automatically
+  .execute();
+
 // Available conditions:
+// .whereId(value)        - Query by primary ID (auto-mapped field)
 // .equals(value)         - Exact match
 // .notEquals(value)      - Not equal
 // .lessThan(value)       - Less than
@@ -348,7 +361,7 @@ getObjectIdFieldName('1000');   // 'customobject1000id'
 // Get display name field
 getNameFieldByObjectType('1');  // 'accountname'
 getNameFieldByObjectType('2');  // 'fullname' (Contact)
-getNameFieldByObjectType('14'); // 'productname' (Product)
+getNameFieldByObjectType('14'); // 'name' (Product)
 
 // Get label field for a lookup/dropdown field
 getLabelFieldForField('accountid', '1');  // 'accountname'
@@ -369,10 +382,10 @@ isLookupField('6');    // true
 | 4 | Opportunity | opportunityid | name |
 | 5 | Case | casesid | title |
 | 6 | Activity | activityid | subject |
-| 7 | Note | noteid | subject |
+| 7 | Note | noteid | notetext |
 | 10 | Task | taskid | subject |
-| 13 | CRM Order | crmorderid | name |
-| 14 | Product | productid | productname |
+| 13 | CRM Order | crmorderid | crmordernumber |
+| 14 | Product | productid | name |
 | 1000+ | Custom Objects | customobject{N}id | name |
 
 ## Error Handling

package/dist/{excludedFields-CGXgZN8Y.d.cts → excludedFields-DSX1EYaT.d.cts}

@@ -122,6 +122,27 @@ declare class QueryBuilder {
      * @param field - Field name to filter on
      */
     where(field: string): ConditionBuilder;
+    /**
+     * Adds a WHERE condition for the primary ID field, automatically mapped based on object type
+     * @param value - The ID value to match
+     * @throws Error if objectType is not set
+     *
+     * @example
+     * ```typescript
+     * // Instead of knowing the exact field name:
+     * new QueryBuilder(client)
+     *   .objectType(1)
+     *   .whereId('abc123')  // Automatically uses 'accountid' for object type 1
+     *   .execute();
+     *
+     * // Equivalent to:
+     * new QueryBuilder(client)
+     *   .objectType(1)
+     *   .where('accountid').equals('abc123')
+     *   .execute();
+     * ```
+     */
+    whereId(value: string | number): this;
     /**
      * Adds an AND logical operator
      */
@@ -231,6 +252,7 @@ declare const FIELD_TYPE_MAPPINGS: Record<string, string>;
 /**
  * Object Type ID to Primary Key Field Mapping
  * Maps Fireberry object type IDs to their primary key field names
+ * Generated from actual API responses
  */
 declare const OBJECT_ID_MAP: Record<number, string>;
 /**
@@ -244,6 +266,7 @@ declare function getObjectIdFieldName(objectTypeId: string | number): string;
 /**
  * Object Type ID to Name Field Mapping
  * Maps Fireberry object type IDs to their display name field
+ * Generated from actual API responses
  */
 declare const OBJECT_NAME_MAP: Record<number, string>;
 /**

package/dist/{excludedFields-CGXgZN8Y.d.ts → excludedFields-DSX1EYaT.d.ts}

@@ -122,6 +122,27 @@ declare class QueryBuilder {
      * @param field - Field name to filter on
      */
     where(field: string): ConditionBuilder;
+    /**
+     * Adds a WHERE condition for the primary ID field, automatically mapped based on object type
+     * @param value - The ID value to match
+     * @throws Error if objectType is not set
+     *
+     * @example
+     * ```typescript
+     * // Instead of knowing the exact field name:
+     * new QueryBuilder(client)
+     *   .objectType(1)
+     *   .whereId('abc123')  // Automatically uses 'accountid' for object type 1
+     *   .execute();
+     *
+     * // Equivalent to:
+     * new QueryBuilder(client)
+     *   .objectType(1)
+     *   .where('accountid').equals('abc123')
+     *   .execute();
+     * ```
+     */
+    whereId(value: string | number): this;
     /**
      * Adds an AND logical operator
      */
@@ -231,6 +252,7 @@ declare const FIELD_TYPE_MAPPINGS: Record<string, string>;
 /**
  * Object Type ID to Primary Key Field Mapping
  * Maps Fireberry object type IDs to their primary key field names
+ * Generated from actual API responses
  */
 declare const OBJECT_ID_MAP: Record<number, string>;
 /**
@@ -244,6 +266,7 @@ declare function getObjectIdFieldName(objectTypeId: string | number): string;
 /**
  * Object Type ID to Name Field Mapping
  * Maps Fireberry object type IDs to their display name field
+ * Generated from actual API responses
  */
 declare const OBJECT_NAME_MAP: Record<number, string>;
 /**

package/dist/index.cjs

@@ -33,7 +33,7 @@ var init_excludedFields = __esm({
     exports.EXCLUDED_FIELDS_FOR_STAR_QUERY = {
       "7": ["deletedon", "deletedby"],
       // Note
-      "8": ["deletedon", "deletedby"],
+      "8": ["deletedon", "deletedby", "s", "w", "o", "t", "description"],
       // Competitor
       "114": ["deletedon", "deletedby"],
       // Calendar Resource
@@ -188,6 +188,128 @@ function chunkArray(array, size) {
   return result;
 }
 
+// src/constants/objectIds.ts
+var OBJECT_ID_MAP = {
+  1: "accountid",
+  // Account
+  2: "contactid",
+  // Contact
+  3: "leadid",
+  // Lead
+  4: "opportunityid",
+  // Opportunity
+  5: "casesid",
+  // Cases
+  6: "activityid",
+  // Activity
+  7: "noteid",
+  // Note
+  8: "competitorid",
+  // Competitor
+  9: "crmuserid",
+  // CrmUser
+  10: "taskid",
+  // Task
+  12: "quoteid",
+  // Quote
+  13: "crmorderid",
+  // CrmOrder
+  14: "productid",
+  // Product
+  17: "crmorderitemid",
+  // CrmOrderItem
+  20: "emailtemplateid",
+  // EmailTemplate
+  23: "businessunitid",
+  // BusinessUnit
+  25: "orgid",
+  // Org
+  27: "printtemplateid",
+  // PrintTemplate
+  28: "contractid",
+  // Contract
+  33: "accountproductid",
+  // AccountProduct
+  46: "projectid",
+  // Project
+  55: "wfruleid",
+  // WFRule
+  58: "mdobjectid",
+  // MDObject
+  64: "roleid",
+  // Role
+  67: "campaignid",
+  // Campaign
+  70: "crmuserloginid",
+  // CrmUserLogin
+  73: "systemfieldid",
+  // SystemField
+  76: "articleid",
+  // Article
+  77: "linkid",
+  // Link
+  78: "invoiceid",
+  // Invoice
+  80: "invoicereceiptitemid",
+  // InvoiceReceiptItem
+  81: "invoiceid",
+  // InvoiceNo
+  82: "invoiceid",
+  // InvoiceDraft
+  83: "invoiceid",
+  // InvoiceReceipt
+  84: "invoiceid",
+  // InvoiceReno
+  85: "invoiceid",
+  // InvoiceCredit
+  86: "invoiceid",
+  // InvoiceDelivery
+  89: "iprestrictionid",
+  // IpRestriction
+  90: "transactionitemid",
+  // TransactionItem
+  93: "chargeid",
+  // Charge
+  100: "calllogid",
+  // calllog
+  101: "attendanceclockid",
+  // AttendanceClock
+  102: "activitylogid",
+  // ActivityLog
+  104: "conversationid",
+  // Conversation
+  105: "teaminboxid",
+  // TeamInbox
+  106: "texttemplateid",
+  // TextTemplate
+  107: "facebookconnectionid",
+  // FacebookConnection
+  109: "auditlogid",
+  // AuditLog
+  110: "smstemplateid",
+  // SMSTemplate
+  111: "providerverificationid",
+  // ProviderVerification
+  114: "calendarresourceid",
+  // CalendarResource
+  115: "journeyid",
+  // Journey
+  116: "profileid",
+  // Profile
+  117: "landingpageid"
+  // LandingPage
+};
+function getObjectIdFieldName(objectTypeId) {
+  const objectTypeNum = typeof objectTypeId === "string" ? parseInt(objectTypeId, 10) : objectTypeId;
+  if (OBJECT_ID_MAP[objectTypeNum]) {
+    return OBJECT_ID_MAP[objectTypeNum];
+  }
+  if (objectTypeNum >= 1e3) {
+    return `customobject${objectTypeNum}id`;
+  }
+  return "id";
+}
+
 // src/utils/queryBuilder.ts
 function escapeQueryValue(value) {
   if (!value) {
@@ -278,6 +400,34 @@ var QueryBuilder = class {
     this.currentField = field;
     return this.createConditionBuilder();
   }
+  /**
+   * Adds a WHERE condition for the primary ID field, automatically mapped based on object type
+   * @param value - The ID value to match
+   * @throws Error if objectType is not set
+   *
+   * @example
+   * ```typescript
+   * // Instead of knowing the exact field name:
+   * new QueryBuilder(client)
+   *   .objectType(1)
+   *   .whereId('abc123')  // Automatically uses 'accountid' for object type 1
+   *   .execute();
+   *
+   * // Equivalent to:
+   * new QueryBuilder(client)
+   *   .objectType(1)
+   *   .where('accountid').equals('abc123')
+   *   .execute();
+   * ```
+   */
+  whereId(value) {
+    if (!this.objectTypeId) {
+      throw new Error("Object type must be set before using whereId(). Call .objectType() first.");
+    }
+    const idField = getObjectIdFieldName(this.objectTypeId);
+    this.addCondition(idField, "=", String(value));
+    return this;
+  }
   /**
    * Adds an AND logical operator
    */
@@ -703,46 +853,6 @@ var MetadataAPI = class {
   }
 };
 
-// src/constants/objectIds.ts
-var OBJECT_ID_MAP = {
-  1: "accountid",
-  2: "contactid",
-  3: "leadid",
-  4: "opportunityid",
-  5: "casesid",
-  6: "activityid",
-  7: "noteid",
-  8: "competitorid",
-  9: "crmuserid",
-  10: "taskid",
-  13: "crmorderid",
-  14: "productid",
-  17: "crmorderitemid",
-  20: "emailtemplateid",
-  23: "businessunitid",
-  27: "printtemplateid",
-  28: "contractid",
-  33: "accountproductid",
-  46: "projectid",
-  67: "campaignid",
-  76: "articleid",
-  86: "invoiceid",
-  101: "attendanceclockid",
-  102: "activitylogid",
-  104: "conversationid",
-  114: "calendarresourceid"
-};
-function getObjectIdFieldName(objectTypeId) {
-  const objectTypeNum = typeof objectTypeId === "string" ? parseInt(objectTypeId, 10) : objectTypeId;
-  if (OBJECT_ID_MAP[objectTypeNum]) {
-    return OBJECT_ID_MAP[objectTypeNum];
-  }
-  if (objectTypeNum >= 1e3) {
-    return `customobject${objectTypeNum}id`;
-  }
-  return "id";
-}
-
 // src/api/records.ts
 var RecordsAPI = class {
   constructor(client) {
@@ -1604,49 +1714,105 @@ var OBJECT_NAME_MAP = {
   4: "name",
   // Opportunity
   5: "title",
-  // Case
+  // Cases
   6: "subject",
   // Activity
-  7: "subject",
+  7: "notetext",
   // Note
-  8: "name",
+  8: "competitorname",
   // Competitor
   9: "fullname",
-  // CRM User
+  // CrmUser
   10: "subject",
   // Task
-  13: "name",
-  // CRM Order
-  14: "productname",
+  12: "quotenumber",
+  // Quote
+  13: "crmordernumber",
+  // CrmOrder
+  14: "name",
   // Product
   17: "productname",
-  // CRM Order Item
-  20: "name",
-  // Email Template
+  // CrmOrderItem
+  20: "title",
+  // EmailTemplate
   23: "name",
-  // Business Unit
+  // BusinessUnit
+  25: "orgname",
+  // Org
   27: "name",
-  // Print Template
-  28: "name",
+  // PrintTemplate
+  28: "contractname",
   // Contract
-  33: "productname",
-  // Account Product
-  46: "name",
+  33: "productid",
+  // AccountProduct (uses productid as display)
+  46: "projectname",
   // Project
-  67: "name",
+  55: "rulename",
+  // WFRule
+  58: "name",
+  // MDObject
+  64: "rolename",
+  // Role
+  67: "campaignname",
   // Campaign
-  76: "title",
+  70: "browsername",
+  // CrmUserLogin
+  73: "label",
+  // SystemField (using label as name field)
+  76: "articlename",
   // Article
-  86: "name",
+  77: "linkname",
+  // Link
+  78: "invoicenumber",
   // Invoice
+  80: "documentnumber",
+  // InvoiceReceiptItem
+  81: "invoicenumber",
+  // InvoiceNo
+  82: "invoicenumber",
+  // InvoiceDraft
+  83: "invoicenumber",
+  // InvoiceReceipt
+  84: "invoicenumber",
+  // InvoiceReno
+  85: "invoicenumber",
+  // InvoiceCredit
+  86: "invoicenumber",
+  // InvoiceDelivery
+  89: "name",
+  // IpRestriction
+  90: "documentnumber",
+  // TransactionItem
+  93: "name",
+  // Charge
+  100: "callerid",
+  // calllog
   101: "name",
-  // Attendance Clock
-  102: "subject",
-  // Activity Log
+  // AttendanceClock
+  102: "activitylognumber",
+  // ActivityLog
   104: "subject",
   // Conversation
-  114: "name"
-  // Calendar Resource
+  105: "name",
+  // TeamInbox
+  106: "name",
+  // TextTemplate
+  107: "name",
+  // FacebookConnection
+  109: "name",
+  // AuditLog
+  110: "name",
+  // SMSTemplate
+  111: "name",
+  // ProviderVerification
+  114: "name",
+  // CalendarResource
+  115: "name",
+  // Journey
+  116: "name",
+  // Profile
+  117: "name"
+  // LandingPage
 };
 
 // src/constants/index.ts