@aloma.io/integration-sdk 3.8.52 → 3.8.54

package/examples/hubspot-controller-individual-params.mts

@@ -0,0 +1,323 @@
+import {AbstractController} from '@aloma.io/integration-sdk';
+
+export default class Controller extends AbstractController {
+  private api: any;
+
+  protected async start(): Promise<void> {
+    const config = this.config;
+
+    this.api = this.getClient({
+      baseUrl: "https://api.hubapi.com",
+      customize(request) {
+        request.headers ||= {};
+
+        request.headers["Authorization"] = `Bearer ${config.apiToken}`;
+      },
+    });
+  }
+  /**
+ * Retrieve a batch of companies
+ *
+ * Retrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.
+ *
+ * @param {boolean} archived (optional) - Whether to return only results that have been archived. [query]
+ *
+ * @param {Object} body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/batch/read response
+   */
+  async read(archived?: any, body?: any) {
+    const url = '/crm/v3/objects/companies/batch/read';
+    const options: any = {
+      method: 'POST',
+      params: {},
+      body,
+    };
+
+    // Add query parameters
+    if (archived !== undefined) {
+      options.params.archived = archived;
+    }
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Retrieve companies
+ *
+ * Retrieve all companies, using query parameters to control the information that gets returned.
+ *
+ * @param {integer} limit (optional) - The maximum number of results to display per page. [query]
+ * @param {string} after (optional) - The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. [query]
+ * @param {array} properties (optional) - A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. [query]
+ * @param {array} propertiesWithHistory (optional) - A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of companies that can be read by a single request. [query]
+ * @param {array} associations (optional) - A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. [query]
+ * @param {boolean} archived (optional) - Whether to return only results that have been archived. [query]
+ *
+ * @returns {Promise<Object>} GET /crm/v3/objects/companies response
+   */
+  async getPage(limit?: any, after?: any, properties?: any, propertiesWithHistory?: any, associations?: any, archived?: any) {
+    const url = '/crm/v3/objects/companies';
+    const options: any = {
+      method: 'GET',
+      params: {},
+    };
+
+    // Add query parameters
+    if (limit !== undefined) {
+      options.params.limit = limit;
+    }
+    if (after !== undefined) {
+      options.params.after = after;
+    }
+    if (properties !== undefined) {
+      options.params.properties = properties;
+    }
+    if (propertiesWithHistory !== undefined) {
+      options.params.propertiesWithHistory = propertiesWithHistory;
+    }
+    if (associations !== undefined) {
+      options.params.associations = associations;
+    }
+    if (archived !== undefined) {
+      options.params.archived = archived;
+    }
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Create a company
+ *
+ * Create a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.
+ *
+ * @param {Object} body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies response
+   */
+  async create(body?: any) {
+    const url = '/crm/v3/objects/companies';
+    const options: any = {
+      method: 'POST',
+      body,
+    };
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Search for companies
+ *
+ * Search for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).
+ *
+ * @param {Object} body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/search response
+   */
+  async doSearch(body?: any) {
+    const url = '/crm/v3/objects/companies/search';
+    const options: any = {
+      method: 'POST',
+      body,
+    };
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Retrieve a company
+ *
+ * Retrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.
+ *
+ * @param {string} companyId (required) - The ID of the company [path]
+ * @param {array} properties (optional) - A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. [query]
+ * @param {array} propertiesWithHistory (optional) - A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. [query]
+ * @param {array} associations (optional) - A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. [query]
+ * @param {boolean} archived (optional) - Whether to return only results that have been archived. [query]
+ * @param {string} idProperty (optional) - The name of a property whose values are unique for this object [query]
+ *
+ * @returns {Promise<Object>} GET /crm/v3/objects/companies/{companyId} response
+   */
+  async getById(companyId: string, properties?: any, propertiesWithHistory?: any, associations?: any, archived?: any, idProperty?: any) {
+    // Build URL with path parameters
+    let url = '/crm/v3/objects/companies/{companyId}';
+    if (companyId) {
+      url = url.replace('{companyId}', companyId);
+    }
+
+    const options: any = {
+      method: 'GET',
+      params: {},
+    };
+
+    // Add query parameters
+    if (properties !== undefined) {
+      options.params.properties = properties;
+    }
+    if (propertiesWithHistory !== undefined) {
+      options.params.propertiesWithHistory = propertiesWithHistory;
+    }
+    if (associations !== undefined) {
+      options.params.associations = associations;
+    }
+    if (archived !== undefined) {
+      options.params.archived = archived;
+    }
+    if (idProperty !== undefined) {
+      options.params.idProperty = idProperty;
+    }
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Update a company
+ *
+ * Update a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
+ *
+ * @param {string} companyId (required) [path]
+ * @param {string} idProperty (optional) - The name of a property whose values are unique for this object [query]
+ *
+ * @param {Object} body (required) - Request body
+ *
+ * @returns {Promise<Object>} PATCH /crm/v3/objects/companies/{companyId} response
+   */
+  async update(companyId: string, idProperty?: any, body?: any) {
+    // Build URL with path parameters
+    let url = '/crm/v3/objects/companies/{companyId}';
+    if (companyId) {
+      url = url.replace('{companyId}', companyId);
+    }
+
+    const options: any = {
+      method: 'PATCH',
+      params: {},
+      body,
+    };
+
+    // Add query parameters
+    if (idProperty !== undefined) {
+      options.params.idProperty = idProperty;
+    }
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Archive a company
+ *
+ * Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).
+ *
+ * @param {string} companyId (required) [path]
+ *
+ * @returns {Promise<Object>} DELETE /crm/v3/objects/companies/{companyId} response
+   */
+  async archive(companyId: string) {
+    // Build URL with path parameters
+    let url = '/crm/v3/objects/companies/{companyId}';
+    if (companyId) {
+      url = url.replace('{companyId}', companyId);
+    }
+
+    const options: any = {
+      method: 'DELETE',
+    };
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Create or update a batch of companies by unique property values
+ *
+ * Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.
+ *
+ * @param {Object} body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/batch/upsert response
+   */
+  async upsert(body?: any) {
+    const url = '/crm/v3/objects/companies/batch/upsert';
+    const options: any = {
+      method: 'POST',
+      body,
+    };
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Create a batch of companies
+ *
+ * Create a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.
+ *
+ * @param {Object} body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/batch/create response
+   */
+  async create(body?: any) {
+    const url = '/crm/v3/objects/companies/batch/create';
+    const options: any = {
+      method: 'POST',
+      body,
+    };
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Update a batch of companies
+ *
+ * Update a batch of companies by ID.
+ *
+ * @param {Object} body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/batch/update response
+   */
+  async update(body?: any) {
+    const url = '/crm/v3/objects/companies/batch/update';
+    const options: any = {
+      method: 'POST',
+      body,
+    };
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Archive a batch of companies
+ *
+ * Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).
+ *
+ * @param {Object} body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/batch/archive response
+   */
+  async archive(body?: any) {
+    const url = '/crm/v3/objects/companies/batch/archive';
+    const options: any = {
+      method: 'POST',
+      body,
+    };
+
+    return this.api.fetch(url, options);
+  }
+
+  /**
+ * Merge two companies
+ *
+ * Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).
+ *
+ * @param {Object} body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/merge response
+   */
+  async merge(body?: any) {
+    const url = '/crm/v3/objects/companies/merge';
+    const options: any = {
+      method: 'POST',
+      body,
+    };
+
+    return this.api.fetch(url, options);
+  }
+}

package/examples/hubspot-controller-with-implementation.mts

@@ -0,0 +1,315 @@
+import {AbstractController} from '@aloma.io/integration-sdk';
+
+export default class Controller extends AbstractController {
+  
+  /**
+ * Retrieve a batch of companies
+ *
+ * Retrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.
+ *
+ * @param {Object} args - Request arguments
+ * @param {boolean} args.archived (optional) - Whether to return only results that have been archived. [query]
+ *
+ * @param {Object} args.body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/batch/read response
+   */
+  async read(args: any = {}) {
+    const url = '/crm/v3/objects/companies/batch/read';
+    const options: any = {
+      method: 'POST',
+      params: {},
+      body: args.body,
+    };
+
+    // Add query parameters
+    if (args.archived !== undefined) {
+      options.params.archived = args.archived;
+    }
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Retrieve companies
+ *
+ * Retrieve all companies, using query parameters to control the information that gets returned.
+ *
+ * @param {Object} args - Request arguments
+ * @param {integer} args.limit (optional) - The maximum number of results to display per page. [query]
+ * @param {string} args.after (optional) - The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. [query]
+ * @param {array} args.properties (optional) - A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. [query]
+ * @param {array} args.propertiesWithHistory (optional) - A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of companies that can be read by a single request. [query]
+ * @param {array} args.associations (optional) - A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. [query]
+ * @param {boolean} args.archived (optional) - Whether to return only results that have been archived. [query]
+ *
+ * @returns {Promise<Object>} GET /crm/v3/objects/companies response
+   */
+  async getPage(args: any = {}) {
+    const url = '/crm/v3/objects/companies';
+    const options: any = {
+      method: 'GET',
+      params: {},
+    };
+
+    // Add query parameters
+    if (args.limit !== undefined) {
+      options.params.limit = args.limit;
+    }
+    if (args.after !== undefined) {
+      options.params.after = args.after;
+    }
+    if (args.properties !== undefined) {
+      options.params.properties = args.properties;
+    }
+    if (args.propertiesWithHistory !== undefined) {
+      options.params.propertiesWithHistory = args.propertiesWithHistory;
+    }
+    if (args.associations !== undefined) {
+      options.params.associations = args.associations;
+    }
+    if (args.archived !== undefined) {
+      options.params.archived = args.archived;
+    }
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Create a company
+ *
+ * Create a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.
+ *
+ * @param {Object} args.body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies response
+   */
+  async create(args: any = {}) {
+    const url = '/crm/v3/objects/companies';
+    const options: any = {
+      method: 'POST',
+      body: args.body,
+    };
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Search for companies
+ *
+ * Search for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).
+ *
+ * @param {Object} args.body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/search response
+   */
+  async doSearch(args: any = {}) {
+    const url = '/crm/v3/objects/companies/search';
+    const options: any = {
+      method: 'POST',
+      body: args.body,
+    };
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Retrieve a company
+ *
+ * Retrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.
+ *
+ * @param {Object} args - Request arguments
+ * @param {string} args.companyId (required) - The ID of the company [path]
+ * @param {array} args.properties (optional) - A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. [query]
+ * @param {array} args.propertiesWithHistory (optional) - A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. [query]
+ * @param {array} args.associations (optional) - A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. [query]
+ * @param {boolean} args.archived (optional) - Whether to return only results that have been archived. [query]
+ * @param {string} args.idProperty (optional) - The name of a property whose values are unique for this object [query]
+ *
+ * @returns {Promise<Object>} GET /crm/v3/objects/companies/{companyId} response
+   */
+  async getById(args: any = {}) {
+    // Build URL with path parameters
+    let url = '/crm/v3/objects/companies/{companyId}';
+    if (args.companyId) {
+      url = url.replace('{companyId}', args.companyId);
+    }
+
+    const options: any = {
+      method: 'GET',
+      params: {},
+    };
+
+    // Add query parameters
+    if (args.properties !== undefined) {
+      options.params.properties = args.properties;
+    }
+    if (args.propertiesWithHistory !== undefined) {
+      options.params.propertiesWithHistory = args.propertiesWithHistory;
+    }
+    if (args.associations !== undefined) {
+      options.params.associations = args.associations;
+    }
+    if (args.archived !== undefined) {
+      options.params.archived = args.archived;
+    }
+    if (args.idProperty !== undefined) {
+      options.params.idProperty = args.idProperty;
+    }
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Update a company
+ *
+ * Update a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
+ *
+ * @param {Object} args - Request arguments
+ * @param {string} args.companyId (required) [path]
+ * @param {string} args.idProperty (optional) - The name of a property whose values are unique for this object [query]
+ *
+ * @param {Object} args.body (required) - Request body
+ *
+ * @returns {Promise<Object>} PATCH /crm/v3/objects/companies/{companyId} response
+   */
+  async update(args: any = {}) {
+    // Build URL with path parameters
+    let url = '/crm/v3/objects/companies/{companyId}';
+    if (args.companyId) {
+      url = url.replace('{companyId}', args.companyId);
+    }
+
+    const options: any = {
+      method: 'PATCH',
+      params: {},
+      body: args.body,
+    };
+
+    // Add query parameters
+    if (args.idProperty !== undefined) {
+      options.params.idProperty = args.idProperty;
+    }
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Archive a company
+ *
+ * Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).
+ *
+ * @param {Object} args - Request arguments
+ * @param {string} args.companyId (required) [path]
+ *
+ * @returns {Promise<Object>} DELETE /crm/v3/objects/companies/{companyId} response
+   */
+  async archive(args: any = {}) {
+    // Build URL with path parameters
+    let url = '/crm/v3/objects/companies/{companyId}';
+    if (args.companyId) {
+      url = url.replace('{companyId}', args.companyId);
+    }
+
+    const options: any = {
+      method: 'DELETE',
+    };
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Create or update a batch of companies by unique property values
+ *
+ * Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.
+ *
+ * @param {Object} args.body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/batch/upsert response
+   */
+  async upsert(args: any = {}) {
+    const url = '/crm/v3/objects/companies/batch/upsert';
+    const options: any = {
+      method: 'POST',
+      body: args.body,
+    };
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Create a batch of companies
+ *
+ * Create a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.
+ *
+ * @param {Object} args.body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/batch/create response
+   */
+  async create(args: any = {}) {
+    const url = '/crm/v3/objects/companies/batch/create';
+    const options: any = {
+      method: 'POST',
+      body: args.body,
+    };
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Update a batch of companies
+ *
+ * Update a batch of companies by ID.
+ *
+ * @param {Object} args.body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/batch/update response
+   */
+  async update(args: any = {}) {
+    const url = '/crm/v3/objects/companies/batch/update';
+    const options: any = {
+      method: 'POST',
+      body: args.body,
+    };
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Archive a batch of companies
+ *
+ * Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).
+ *
+ * @param {Object} args.body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/batch/archive response
+   */
+  async archive(args: any = {}) {
+    const url = '/crm/v3/objects/companies/batch/archive';
+    const options: any = {
+      method: 'POST',
+      body: args.body,
+    };
+
+    return this.fetcher.fetch(url, options);
+  }
+
+  /**
+ * Merge two companies
+ *
+ * Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).
+ *
+ * @param {Object} args.body (required) - Request body
+ *
+ * @returns {Promise<Object>} POST /crm/v3/objects/companies/merge response
+   */
+  async merge(args: any = {}) {
+    const url = '/crm/v3/objects/companies/merge';
+    const options: any = {
+      method: 'POST',
+      body: args.body,
+    };
+
+    return this.fetcher.fetch(url, options);
+  }
+}