# Companies (*crm.companies*) ## Overview ### Available Operations * [list](#list) - List companies * [create](#create) - Create company * [get](#get) - Get company * [update](#update) - Update company * [delete](#delete) - Delete company ## list List companies ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.crm.companies.list({ serviceId: "salesforce", filter: { name: "SpaceX", }, sort: { by: "created_at", direction: "desc", }, passThrough: { "search": "San Francisco", }, fields: "id,updated_at", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { crmCompaniesList } from "@apideck/sdk/funcs/crmCompaniesList.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await crmCompaniesList(apideck, { serviceId: "salesforce", filter: { name: "SpaceX", }, sort: { by: "created_at", direction: "desc", }, passThrough: { "search": "San Francisco", }, fields: "id,updated_at", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CrmCompaniesAllRequest](../../models/operations/crmcompaniesallrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.CrmCompaniesAllResponse](../../models/operations/crmcompaniesallresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## create Create company ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; import { RFCDate } from "@apideck/sdk/types"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.crm.companies.create({ serviceId: "salesforce", company: { name: "SpaceX", ownerId: "12345", image: "https://www.spacex.com/static/images/share.jpg", description: "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", vatNumber: "BE0689615164", currency: "USD", status: "Open", fax: "+12129876543", annualRevenue: "+$35m", numberOfEmployees: "500-1000", industry: "Apparel", ownership: "Public", salesTaxNumber: "12456EN", payeeNumber: "78932EN", abnOrTfn: "46 115 614 695", abnBranch: "123", acn: "XXX XXX XXX", firstName: "Elon", lastName: "Musk", bankAccounts: [ { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, ], websites: [ { id: "12345", url: "http://example.com", type: "primary", }, ], addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, ], rowType: { id: "12345", name: "Customer Account", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: "Uses Salesforce and Marketo", }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: "Uses Salesforce and Marketo", }, ], tags: [ "New", ], readOnly: false, salutation: "Mr", birthday: new RFCDate("2000-08-12"), passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { crmCompaniesCreate } from "@apideck/sdk/funcs/crmCompaniesCreate.js"; import { RFCDate } from "@apideck/sdk/types"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await crmCompaniesCreate(apideck, { serviceId: "salesforce", company: { name: "SpaceX", ownerId: "12345", image: "https://www.spacex.com/static/images/share.jpg", description: "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", vatNumber: "BE0689615164", currency: "USD", status: "Open", fax: "+12129876543", annualRevenue: "+$35m", numberOfEmployees: "500-1000", industry: "Apparel", ownership: "Public", salesTaxNumber: "12456EN", payeeNumber: "78932EN", abnOrTfn: "46 115 614 695", abnBranch: "123", acn: "XXX XXX XXX", firstName: "Elon", lastName: "Musk", bankAccounts: [ { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, ], websites: [ { id: "12345", url: "http://example.com", type: "primary", }, ], addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, ], rowType: { id: "12345", name: "Customer Account", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: "Uses Salesforce and Marketo", }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: "Uses Salesforce and Marketo", }, ], tags: [ "New", ], readOnly: false, salutation: "Mr", birthday: new RFCDate("2000-08-12"), passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CrmCompaniesAddRequest](../../models/operations/crmcompaniesaddrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.CrmCompaniesAddResponse](../../models/operations/crmcompaniesaddresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## get Get company ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.crm.companies.get({ id: "", serviceId: "salesforce", fields: "id,updated_at", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { crmCompaniesGet } from "@apideck/sdk/funcs/crmCompaniesGet.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await crmCompaniesGet(apideck, { id: "", serviceId: "salesforce", fields: "id,updated_at", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CrmCompaniesOneRequest](../../models/operations/crmcompaniesonerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.CrmCompaniesOneResponse](../../models/operations/crmcompaniesoneresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## update Update company ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; import { RFCDate } from "@apideck/sdk/types"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.crm.companies.update({ id: "", serviceId: "salesforce", company: { name: "SpaceX", ownerId: "12345", image: "https://www.spacex.com/static/images/share.jpg", description: "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", vatNumber: "BE0689615164", currency: "USD", status: "Open", fax: "+12129876543", annualRevenue: "+$35m", numberOfEmployees: "500-1000", industry: "Apparel", ownership: "Public", salesTaxNumber: "12456EN", payeeNumber: "78932EN", abnOrTfn: "46 115 614 695", abnBranch: "123", acn: "XXX XXX XXX", firstName: "Elon", lastName: "Musk", bankAccounts: [ { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, ], websites: [ { id: "12345", url: "http://example.com", type: "primary", }, { id: "12345", url: "http://example.com", type: "primary", }, ], addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, ], rowType: { id: "12345", name: "Customer Account", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, ], tags: [ "New", ], readOnly: false, salutation: "Mr", birthday: new RFCDate("2000-08-12"), passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { crmCompaniesUpdate } from "@apideck/sdk/funcs/crmCompaniesUpdate.js"; import { RFCDate } from "@apideck/sdk/types"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await crmCompaniesUpdate(apideck, { id: "", serviceId: "salesforce", company: { name: "SpaceX", ownerId: "12345", image: "https://www.spacex.com/static/images/share.jpg", description: "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", vatNumber: "BE0689615164", currency: "USD", status: "Open", fax: "+12129876543", annualRevenue: "+$35m", numberOfEmployees: "500-1000", industry: "Apparel", ownership: "Public", salesTaxNumber: "12456EN", payeeNumber: "78932EN", abnOrTfn: "46 115 614 695", abnBranch: "123", acn: "XXX XXX XXX", firstName: "Elon", lastName: "Musk", bankAccounts: [ { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, ], websites: [ { id: "12345", url: "http://example.com", type: "primary", }, { id: "12345", url: "http://example.com", type: "primary", }, ], addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, ], rowType: { id: "12345", name: "Customer Account", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, ], tags: [ "New", ], readOnly: false, salutation: "Mr", birthday: new RFCDate("2000-08-12"), passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CrmCompaniesUpdateRequest](../../models/operations/crmcompaniesupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.CrmCompaniesUpdateResponse](../../models/operations/crmcompaniesupdateresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## delete Delete company ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.crm.companies.delete({ id: "", serviceId: "salesforce", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { crmCompaniesDelete } from "@apideck/sdk/funcs/crmCompaniesDelete.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await crmCompaniesDelete(apideck, { id: "", serviceId: "salesforce", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CrmCompaniesDeleteRequest](../../models/operations/crmcompaniesdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.CrmCompaniesDeleteResponse](../../models/operations/crmcompaniesdeleteresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* |