From a907df9210b3c3e23d3ab83a964f1c2d39bff431 Mon Sep 17 00:00:00 2001 From: Samir AMZANI Date: Tue, 10 Dec 2024 13:51:40 +0100 Subject: [PATCH] fix: format --- .speakeasy/gen.lock | 352 ++++++++++-------- .speakeasy/overlay-spec.yaml | 8 + .speakeasy/workflow.lock | 17 +- .speakeasy/workflow.yaml | 2 + README.md | 40 +- USAGE.md | 8 +- docs/models/connectordoc.md | 2 +- docs/models/filestoragefilesexportrequest.md | 2 +- docs/models/{format.md => format_.md} | 0 docs/sdks/activities/README.md | 20 +- docs/sdks/apideckcompanies/README.md | 20 +- docs/sdks/apideckcustomers/README.md | 8 +- docs/sdks/apideckdepartments/README.md | 20 +- docs/sdks/apiresourcecoveragesdk/README.md | 4 +- docs/sdks/apiresources/README.md | 4 +- docs/sdks/apis/README.md | 8 +- docs/sdks/applicants/README.md | 20 +- docs/sdks/applications/README.md | 20 +- docs/sdks/attachments/README.md | 16 +- docs/sdks/balancesheetsdk/README.md | 4 +- docs/sdks/billpayments/README.md | 20 +- docs/sdks/bills/README.md | 20 +- docs/sdks/collections/README.md | 8 +- docs/sdks/collectiontags/README.md | 4 +- docs/sdks/collectionticketcomments/README.md | 20 +- docs/sdks/collectiontickets/README.md | 20 +- docs/sdks/collectionusers/README.md | 8 +- docs/sdks/companies/README.md | 20 +- docs/sdks/companyinfosdk/README.md | 4 +- docs/sdks/connectioncustommappings/README.md | 4 +- docs/sdks/connections/README.md | 24 +- docs/sdks/connectionsettings/README.md | 8 +- docs/sdks/connectordocs/README.md | 4 +- docs/sdks/connectorresources/README.md | 4 +- docs/sdks/connectors/README.md | 8 +- docs/sdks/consumerrequestcounts/README.md | 4 +- docs/sdks/consumers/README.md | 20 +- docs/sdks/contacts/README.md | 20 +- docs/sdks/createcallback/README.md | 4 +- docs/sdks/creditnotes/README.md | 20 +- docs/sdks/customers/README.md | 20 +- docs/sdks/customfields/README.md | 4 +- docs/sdks/custommappingssdk/README.md | 4 +- docs/sdks/departments/README.md | 20 +- docs/sdks/drivegroups/README.md | 20 +- docs/sdks/drives/README.md | 20 +- docs/sdks/employeepayrolls/README.md | 8 +- docs/sdks/employees/README.md | 20 +- docs/sdks/employeeschedulessdk/README.md | 4 +- docs/sdks/eventlogs/README.md | 4 +- docs/sdks/expenses/README.md | 20 +- docs/sdks/files/README.md | 30 +- docs/sdks/folders/README.md | 20 +- docs/sdks/invoiceitems/README.md | 20 +- docs/sdks/invoices/README.md | 20 +- docs/sdks/jobs/README.md | 8 +- docs/sdks/journalentries/README.md | 20 +- docs/sdks/leads/README.md | 20 +- docs/sdks/ledgeraccounts/README.md | 20 +- docs/sdks/locations/README.md | 20 +- docs/sdks/logs/README.md | 4 +- docs/sdks/messages/README.md | 20 +- docs/sdks/notes/README.md | 20 +- docs/sdks/opportunities/README.md | 20 +- docs/sdks/orders/README.md | 8 +- docs/sdks/payments/README.md | 20 +- docs/sdks/payrolls/README.md | 8 +- docs/sdks/pipelines/README.md | 20 +- docs/sdks/products/README.md | 8 +- docs/sdks/profitandlosssdk/README.md | 4 +- docs/sdks/purchaseorders/README.md | 20 +- docs/sdks/sessions/README.md | 4 +- docs/sdks/sharedlinks/README.md | 20 +- docs/sdks/stores/README.md | 4 +- docs/sdks/subsidiaries/README.md | 20 +- docs/sdks/suppliers/README.md | 20 +- docs/sdks/taxrates/README.md | 20 +- docs/sdks/timeoffrequests/README.md | 20 +- docs/sdks/trackingcategories/README.md | 20 +- docs/sdks/uploadsessions/README.md | 16 +- docs/sdks/users/README.md | 20 +- docs/sdks/validateconnection/README.md | 4 +- docs/sdks/webhooks/README.md | 20 +- pyproject.toml | 6 +- src/apideck_unify/_version.py | 2 +- src/apideck_unify/attachments.py | 2 +- src/apideck_unify/basesdk.py | 7 + src/apideck_unify/files.py | 16 +- src/apideck_unify/models/connectordoc.py | 7 +- .../models/filestorage_filesexportop.py | 4 +- src/apideck_unify/sdkconfiguration.py | 6 +- 91 files changed, 799 insertions(+), 732 deletions(-) create mode 100644 .speakeasy/overlay-spec.yaml rename docs/models/{format.md => format_.md} (100%) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 3031fa0..3c91fdc 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,18 +1,19 @@ lockVersion: 2.0.0 id: fca0ac3a-5f4e-452c-bbc7-2311afa8da40 management: - docChecksum: 5a3c61710af05ae5c21380b118217322 + docChecksum: e0a152df239fd8497c0b664a85c58056 docVersion: 10.8.3 - speakeasyVersion: 1.453.0 - generationVersion: 2.472.1 - releaseVersion: 0.0.1 - configChecksum: 03df0028eed2290985e2618695deb848 + speakeasyVersion: 1.453.8 + generationVersion: 2.474.15 + releaseVersion: 0.1.7 + configChecksum: cea5b059544e6c210b438ae697b2f2c9 + published: true features: python: acceptHeaders: 3.0.0 additionalDependencies: 1.0.0 constsAndDefaults: 1.0.5 - core: 5.6.9 + core: 5.6.11 deepObjectParams: 0.1.0 defaultEnabledRetries: 0.2.0 deprecations: 3.0.0 @@ -938,7 +939,7 @@ generatedFiles: - docs/models/five.md - docs/models/flsastatus.md - docs/models/folder.md - - docs/models/format.md + - docs/models/format_.md - docs/models/formfield.md - docs/models/formfieldoption.md - docs/models/formfieldoptiongroup.md @@ -2575,6 +2576,7 @@ examples: accounting.taxRatesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -2587,7 +2589,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -2648,7 +2650,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.taxRatesDelete: "": parameters: @@ -2671,7 +2673,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.billsAll: @@ -2704,6 +2706,7 @@ examples: accounting.billsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -2716,7 +2719,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -2800,7 +2803,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.invoicesAll: @@ -2817,7 +2820,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"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"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [], "line_items": [], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"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"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [], "line_items": [], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -2833,12 +2836,13 @@ examples: accounting.invoicesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": []}]} + application/json: {"type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "row_version": "1-12345"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": ["", "", ""]}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": []}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "add", "data": {"id": "12345", "downstream_id": "12345"}} @@ -2867,7 +2871,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}]}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "code": "N-T", "name": "GST on Purchases", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -2891,7 +2895,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [], "row_version": "1-12345", "pass_through": []} + application/json: {"type": "service", "number": "OIT00546", "customer": {"id": "12345", "display_name": "Windsurf Shop", "email": "boring@boring.com"}, "company_id": "12345", "invoice_date": "2020-09-30", "due_date": "2020-09-30", "terms": "Net 30 days", "po_number": "90000117", "reference": "123456", "status": "draft", "invoice_sent": true, "currency": "USD", "currency_rate": 0.69, "tax_inclusive": true, "sub_total": 27500, "total_tax": 2500, "tax_code": "1234", "discount_percentage": 5.5, "discount_amount": 25, "total": 27500, "balance": 27500, "deposit": 0, "customer_memo": "Thank you for your business and have a great day!", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "line_items": [{"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345"}, {"id": "12345", "row_id": "12345", "code": "120-C", "line_number": 1, "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "type": "sales_item", "tax_amount": 27500, "total_amount": 27500, "quantity": 1, "unit_price": 27500.5, "unit_of_measure": "pc.", "discount_percentage": 0.01, "discount_amount": 19.99, "location_id": "1234", "department_id": "1234", "item": {"id": "12344", "code": "120-C", "name": "Model Y"}, "tax_rate": {"id": "123456", "rate": 10}, "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "row_version": "1-12345"}], "billing_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "shipping_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "template_id": "123456", "source_document_url": "https://www.invoicesolution.com/invoice/123456", "payment_method": "cash", "channel": "email", "language": "EN", "accounting_by_row": false, "bank_account": {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, "ledger_account": {"id": "123456", "nominal_code": "N091", "code": "453"}, "custom_fields": [], "row_version": "1-12345", "pass_through": []} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "invoices", "operation": "update", "data": {"id": "12345", "downstream_id": "12345"}} @@ -2906,7 +2910,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.invoicesDelete: "": parameters: @@ -2929,7 +2933,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.ledgerAccountsAll: @@ -2962,6 +2966,7 @@ examples: accounting.ledgerAccountsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -2980,7 +2985,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.ledgerAccountsOne: @@ -3035,7 +3040,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.ledgerAccountsDelete: "": parameters: @@ -3058,7 +3063,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.invoiceItemsAll: @@ -3090,6 +3095,7 @@ examples: accounting.invoiceItemsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -3102,7 +3108,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -3164,7 +3170,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.invoiceItemsDelete: "": parameters: @@ -3187,7 +3193,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.creditNotesAll: @@ -3220,6 +3226,7 @@ examples: accounting.creditNotesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -3230,7 +3237,7 @@ examples: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "credit-notes", "operation": "add", "data": {"id": "12345"}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": @@ -3291,7 +3298,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.creditNotesDelete: @@ -3316,7 +3323,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.customersAll: @@ -3349,6 +3356,7 @@ examples: accounting.customersAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -3361,15 +3369,15 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.customersOne: "": parameters: @@ -3445,7 +3453,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.suppliersAll: @@ -3478,6 +3486,7 @@ examples: accounting.suppliersAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -3490,15 +3499,15 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.suppliersOne: "": parameters: @@ -3574,7 +3583,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.paymentsAll: @@ -3591,7 +3600,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "payments", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_receivable", "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_receivable", "allocations": [], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_receivable", "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"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"}], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "payments", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_receivable", "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_receivable", "allocations": [], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "customer": {"id": "12345", "display_id": "CUST00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "email": "boring@boring.com"}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_receivable", "allocations": [{"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "123456", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"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"}], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -3607,6 +3616,7 @@ examples: accounting.paymentsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -3617,7 +3627,7 @@ examples: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "payments", "operation": "add", "data": {"id": "12345"}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": @@ -3703,7 +3713,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.companyInfoOne: @@ -3811,6 +3821,7 @@ examples: accounting.journalEntriesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -3823,7 +3834,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -3907,7 +3918,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.purchaseOrdersAll: @@ -3939,6 +3950,7 @@ examples: accounting.purchaseOrdersAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -3951,15 +3963,15 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.purchaseOrdersOne: "": parameters: @@ -4011,7 +4023,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.purchaseOrdersDelete: "": parameters: @@ -4034,7 +4046,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.subsidiariesAll: @@ -4064,6 +4076,7 @@ examples: accounting.subsidiariesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -4082,7 +4095,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.subsidiariesOne: @@ -4137,7 +4150,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.subsidiariesDelete: "": parameters: @@ -4160,7 +4173,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.locationsAll: @@ -4191,6 +4204,7 @@ examples: accounting.locationsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -4203,7 +4217,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -4264,7 +4278,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.locationsDelete: "": parameters: @@ -4287,7 +4301,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.departmentsAll: @@ -4318,6 +4332,7 @@ examples: accounting.departmentsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -4330,7 +4345,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -4391,7 +4406,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.departmentsDelete: "": parameters: @@ -4414,7 +4429,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.attachmentsAll: @@ -4496,7 +4511,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.attachmentsDownload: @@ -4520,11 +4535,12 @@ examples: "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "200": {} accounting.trackingCategoriesAll: "": parameters: @@ -4553,6 +4569,7 @@ examples: accounting.trackingCategoriesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -4571,7 +4588,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.trackingCategoriesOne: @@ -4626,7 +4643,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.trackingCategoriesDelete: "": parameters: @@ -4649,7 +4666,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.billPaymentsAll: @@ -4666,7 +4683,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "payments", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_payable", "allocations": [{"id": "12345", "type": "bill", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "12345", "type": "bill", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_payable", "allocations": [], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_payable", "allocations": [{"id": "12345", "type": "bill", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "12345", "type": "bill", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"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"}], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "payments", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_payable", "allocations": [{"id": "12345", "type": "bill", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "12345", "type": "bill", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_payable", "allocations": [], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "downstream_id": "12345", "currency": "USD", "currency_rate": 0.69, "total_amount": 49.99, "reference": "123456", "payment_method": "cash", "payment_method_reference": "123456", "payment_method_id": "12345", "account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453"}, "transaction_date": "2021-05-01T12:00:00.000Z", "supplier": {"id": "12345", "display_id": "SUPP00101", "display_name": "Windsurf Shop", "company_name": "The boring company", "address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, "company_id": "12345", "reconciled": true, "status": "authorised", "type": "accounts_payable", "allocations": [{"id": "12345", "type": "bill", "code": "N091", "amount": 49.99, "allocation_id": "123456"}, {"id": "12345", "type": "bill", "code": "N091", "amount": 49.99, "allocation_id": "123456"}], "note": "Some notes about this transaction", "number": "123456", "tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "custom_fields": [{"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"}], "row_version": "1-12345", "display_id": "123456", "updated_by": "12345", "created_by": "12345", "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -4682,6 +4699,7 @@ examples: accounting.billPaymentsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -4692,7 +4710,7 @@ examples: "201": application/json: {"status_code": 200, "status": "OK", "service": "xero", "resource": "payments", "operation": "add", "data": {"id": "12345"}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": @@ -4778,12 +4796,13 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} accounting.expensesAll: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -4806,6 +4825,7 @@ examples: accounting.expensesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -4816,7 +4836,7 @@ examples: "201": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Expenses", "operation": "add", "data": {"id": "12345"}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": @@ -4863,7 +4883,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "rate": 10}, "total_amount": 275, "line_items": [{"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": []}]} + application/json: {"number": "OIT00546", "transaction_date": "2021-05-01T12:00:00.000Z", "account_id": "123456", "customer_id": "12345", "supplier_id": "12345", "company_id": "12345", "department_id": "12345", "payment_type": "cash", "currency": "USD", "currency_rate": 0.69, "type": "expense", "memo": "For travel expenses incurred on 2024-05-15", "tax_rate": {"id": "123456", "rate": 10}, "total_amount": 275, "line_items": [{"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}, {"tracking_categories": [{"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}, {"id": "123456", "name": "New York"}], "account_id": "123456", "customer_id": "12345", "department_id": "12345", "location_id": "12345", "tax_rate": {"id": "123456", "rate": 10}, "description": "Travel US.", "total_amount": 275, "billable": true}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "row_version": "1-12345", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": []}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "Expenses", "operation": "update", "data": {"id": "12345"}} @@ -4901,7 +4921,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} ats.jobsAll: @@ -4968,7 +4988,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "lever", "resource": "Applicants", "operation": "all", "data": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "phone_numbers": [], "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "phone_numbers": [], "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "lever", "resource": "Applicants", "operation": "all", "data": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "phone_numbers": [], "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "phone_numbers": [], "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "initials": "EM", "birthday": "2000-08-12", "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", "job_url": "https://democompany.recruitee.com/o/example-talent-pool", "photo_url": "https://unavatar.io/elon-musk", "headline": "PepsiCo, Inc, Central Perk", "title": "CEO", "emails": [], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "social_links": [], "stage_id": "12345", "recruiter_id": "12345", "coordinator_id": "12345", "application_ids": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "applications": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "followers": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "sources": ["Job site"], "source_id": "12345", "confidential": false, "anonymized": true, "tags": ["New"], "archived": false, "last_interaction_at": "2020-09-30T07:43:32.000Z", "owner_id": "54321", "sourced_by": "12345", "cv_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/36615291/pdf_cv_38swhu4w42k1.pdf?response-content-disposition=inline&response-content-type=application%2Fpdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYHB7CA5RLR4Y3ON%2F20220514%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20220514T235654Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Signature=72c0621f5976db75b54de487eb821a8e73480d7f2a6a4a9713ab997944b0561f", "record_url": "https://app.intercom.io/contacts/12345", "rejected_at": "2020-09-30T07:43:32.000Z", "deleted": true, "deleted_by": "12345", "deleted_at": "2020-09-30T07:43:32.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -4984,6 +5004,7 @@ examples: ats.applicantsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -4996,15 +5017,15 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} ats.applicantsOne: "": parameters: @@ -5080,7 +5101,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} ats.applicationsAll: @@ -5110,6 +5131,7 @@ examples: ats.applicationsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -5128,7 +5150,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} ats.applicationsOne: @@ -5182,7 +5204,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} ats.applicationsDelete: "": parameters: @@ -5205,7 +5227,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.companiesAll: @@ -5222,7 +5244,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "all", "data": [{"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "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.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [], "social_links": [], "phone_numbers": [], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "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.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [], "phone_numbers": [], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "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.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [], "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "all", "data": [{"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "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.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"id": "12345", "url": "http://example.com", "type": "primary"}], "addresses": [], "social_links": [], "phone_numbers": [], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}, {"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "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.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}, {"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [], "phone_numbers": [], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}, {"id": "12345", "name": "SpaceX", "interaction_count": 1, "owner_id": "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.", "vat_number": "BE0689615164", "currency": "USD", "status": "Open", "fax": "+12129876543", "annual_revenue": "+$35m", "number_of_employees": "500-1000", "industry": "Apparel", "ownership": "Public", "sales_tax_number": "12456EN", "payee_number": "78932EN", "abn_or_tfn": "46 115 614 695", "abn_branch": "123", "acn": "XXX XXX XXX", "first_name": "Elon", "last_name": "Musk", "parent_id": "22345", "bank_accounts": [], "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [{"id": "123", "email": "elon@musk.com", "type": "primary"}], "row_type": {"id": "12345", "name": "Customer Account"}, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "tags": ["New"], "read_only": false, "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "salutation": "Mr", "birthday": "2000-08-12", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5238,6 +5260,7 @@ examples: crm.companiesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -5248,7 +5271,7 @@ examples: "201": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "add", "data": {"id": "12345"}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": @@ -5334,7 +5357,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.contactsAll: @@ -5351,7 +5374,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "contacts", "operation": "all", "data": [{"id": "12345", "name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [], "phone_numbers": [], "emails": [], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "first_call_at": "2020-09-30T07:43:32.000Z", "first_email_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z", "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": []}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [], "emails": [], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "tags": ["New"], "first_call_at": "2020-09-30T07:43:32.000Z", "first_email_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z", "opportunity_ids": ["12345"], "pass_through": []}, {"id": "12345", "name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"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"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "tags": ["New"], "first_call_at": "2020-09-30T07:43:32.000Z", "first_email_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z", "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": []}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "contacts", "operation": "all", "data": [{"id": "12345", "name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [], "phone_numbers": [], "emails": [], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "first_call_at": "2020-09-30T07:43:32.000Z", "first_email_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z", "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": []}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [], "emails": [], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "tags": ["New"], "first_call_at": "2020-09-30T07:43:32.000Z", "first_email_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z", "opportunity_ids": ["12345"], "pass_through": []}, {"id": "12345", "name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"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"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "tags": ["New"], "first_call_at": "2020-09-30T07:43:32.000Z", "first_email_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z", "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": []}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5367,17 +5390,18 @@ examples: crm.contactsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [], "emails": [], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}]} + application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [], "emails": [], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "contacts", "operation": "add", "data": {"id": "12345"}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": @@ -5426,7 +5450,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "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"}], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": []}]} + application/json: {"name": "Elon Musk", "owner_id": "54321", "type": "personal", "company_id": "23456", "company_name": "23456", "lead_id": "34567", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "title": "CEO", "department": "Engineering", "language": "EN", "gender": "female", "birthday": "2000-08-12", "photo_url": "https://unavatar.io/elon-musk", "lead_source": "Cold Call", "fax": "+12129876543", "description": "Internal champion", "current_balance": 10.5, "status": "open", "active": true, "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "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"}], "email_domain": "gmail.com", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "tags": ["New"], "opportunity_ids": ["12345"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": []}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "contacts", "operation": "update", "data": {"id": "12345"}} @@ -5464,7 +5488,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.opportunitiesAll: @@ -5481,7 +5505,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "opportunities", "operation": "all", "data": [{"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "opportunities", "operation": "all", "data": [{"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", "type": "Existing Customer - Upgrade", "monetary_amount": 75000, "currency": "USD", "win_probability": 40, "expected_revenue": 75000, "close_date": "2020-10-30", "loss_reason_id": "12345", "loss_reason": "No budget", "won_reason_id": "12345", "won_reason": "Best pitch", "pipeline_id": "12345", "pipeline_stage_id": "12345", "source_id": "12345", "lead_id": "12345", "lead_source": "Website", "contact_id": "12345", "contact_ids": ["12345"], "company_id": "12345", "company_name": "Copper", "owner_id": "12345", "priority": "None", "status": "Open", "status_id": "12345", "tags": ["New"], "interaction_count": 0, "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}], "stage_last_changed_at": "2020-09-30T07:43:32.000Z", "last_activity_at": "2020-09-30T07:43:32.000Z", "deleted": false, "date_stage_changed": "2020-09-30T00:00:00.000Z", "date_last_contacted": "2020-09-30T00:00:00.000Z", "date_lead_created": "2020-09-30T00:00:00.000Z", "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5497,6 +5521,7 @@ examples: crm.opportunitiesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -5509,7 +5534,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -5593,7 +5618,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.leadsAll: @@ -5610,7 +5635,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "all", "data": [{"id": "12345", "name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [], "phone_numbers": [], "emails": [], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [], "emails": [], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "tags": ["New"], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"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"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "tags": ["New"], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": []}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "all", "data": [{"id": "12345", "name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [], "phone_numbers": [], "emails": [], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level"}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}, {"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [], "emails": [], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}], "tags": ["New"], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": []}, {"id": "12345", "name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"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"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}], "emails": [], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "tags": ["New"], "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": []}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -5626,17 +5651,18 @@ examples: crm.leadsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [], "emails": [], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}]} + application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [], "emails": [], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"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"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"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"}}}]}]} responses: "201": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "add", "data": {"id": "12345"}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": @@ -5684,7 +5710,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "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"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": []}]} + application/json: {"name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", "owner_name": "John Doe", "company_id": "2", "lead_id": "2", "lead_source": "Cold Call", "first_name": "Elon", "last_name": "Musk", "description": "A thinker", "prefix": "Sir", "title": "CEO", "language": "EN", "status": "New", "monetary_amount": 75000, "currency": "USD", "fax": "+12129876543", "websites": [{"id": "12345", "url": "http://example.com", "type": "primary"}, {"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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "social_links": [{"id": "12345", "url": "https://www.twitter.com/apideck", "type": "twitter"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "323", "number": "111-111-1111", "extension": "105", "type": "primary"}, {"id": "12345", "country_code": "1", "area_code": "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"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "tags": ["New"], "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": []}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "companies", "operation": "update", "data": {"id": "12345"}} @@ -5722,7 +5748,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.pipelinesAll: @@ -5753,6 +5779,7 @@ examples: crm.pipelinesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -5765,7 +5792,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -5826,7 +5853,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.pipelinesDelete: "": parameters: @@ -5849,7 +5876,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.notesAll: @@ -5880,6 +5907,7 @@ examples: crm.notesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -5898,7 +5926,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.notesOne: @@ -5953,7 +5981,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.notesDelete: "": parameters: @@ -5976,7 +6004,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.usersAll: @@ -6007,6 +6035,7 @@ examples: crm.usersAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -6019,7 +6048,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -6103,7 +6132,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} crm.activitiesAll: @@ -6120,7 +6149,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "activities", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "attendees": [], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"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"}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} + application/json: {"status_code": 200, "status": "OK", "service": "zoho-crm", "resource": "activities", "operation": "all", "data": [{"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": 10}], "attendees": [], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [{"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"}], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}, {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": [{"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}, {"path": "$.nested.property", "value": {"TaxClassificationRef": {"value": "EUC-99990201-V1-00020000"}}}]}, {"service_id": "", "extend_paths": []}]}, {"id": "12345", "downstream_id": "12345", "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, "user_id": "12345", "account_id": "12345", "contact_id": "12345", "company_id": "12345", "opportunity_id": "12345", "lead_id": "12345", "owner_id": "12345", "campaign_id": "12345", "case_id": "12345", "asset_id": "12345", "contract_id": "12345", "product_id": "12345", "solution_id": "12345", "custom_object_id": "12345", "type": "meeting", "title": "Meeting", "description": "More info about the meeting", "note": "An internal note about the meeting", "location": "Space", "location_address": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}, "all_day_event": false, "private": true, "group_event": true, "event_sub_type": "debrief", "group_event_type": "Proposed", "child": false, "archived": false, "deleted": false, "show_as": "busy", "done": false, "start_datetime": "2021-05-01T12:00:00.000Z", "end_datetime": "2021-05-01T12:30:00.000Z", "duration_minutes": 30, "activity_date": "2021-05-01", "end_date": "2021-05-01", "recurrent": false, "reminder_datetime": "2021-05-01T17:00:00.000Z", "reminder_set": false, "video_conference_url": "https://us02web.zoom.us/j/88120759396", "video_conference_id": "zoom:88120759396", "custom_fields": [], "attendees": [{"id": "12345", "name": "Elon Musk", "first_name": "Elon", "middle_name": "D.", "last_name": "Musk", "prefix": "Mr.", "suffix": "PhD", "email_address": "elon@musk.com", "is_organizer": true, "status": "accepted", "user_id": "12345", "contact_id": "12345", "updated_at": "2017-08-12T20:43:21.291Z", "created_at": "2017-08-12T20:43:21.291Z"}], "updated_by": "12345", "created_by": "12345", "updated_at": "2020-09-30T07:43:32.000Z", "created_at": "2020-09-30T07:43:32.000Z", "pass_through": [{"service_id": "", "extend_paths": []}]}], "meta": {"items_on_page": 50, "cursors": {"previous": "em9oby1jcm06OnBhZ2U6OjE=", "current": "em9oby1jcm06OnBhZ2U6OjI=", "next": "em9oby1jcm06OnBhZ2U6OjM="}}, "links": {"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D", "current": "https://unify.apideck.com/crm/companies", "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -6136,6 +6165,7 @@ examples: crm.activitiesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -6148,7 +6178,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -6232,7 +6262,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} ecommerce.ordersAll: @@ -6469,7 +6499,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.filesOne: "": parameters: @@ -6522,7 +6552,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.filesDelete: "": parameters: @@ -6545,7 +6575,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.filesDownload: @@ -6567,11 +6597,12 @@ examples: "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "200": {} fileStorage.filesExport: "": parameters: @@ -6580,6 +6611,7 @@ examples: query: fields: "id,updated_at" format: "pdf" + file_format: "pdf" header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -6594,9 +6626,10 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} + "200": {} fileStorage.foldersAdd: "": parameters: @@ -6620,7 +6653,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.foldersOne: @@ -6675,7 +6708,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.foldersDelete: "": parameters: @@ -6698,7 +6731,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.foldersCopy: @@ -6728,7 +6761,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.sharedLinksAll: "": parameters: @@ -6757,6 +6790,7 @@ examples: fileStorage.sharedLinksAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -6775,7 +6809,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.sharedLinksOne: @@ -6830,7 +6864,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.sharedLinksDelete: "": parameters: @@ -6853,12 +6887,13 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.uploadSessionsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -6877,7 +6912,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.uploadSessionsOne: @@ -6928,7 +6963,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.uploadSessionsFinish: @@ -6985,6 +7020,7 @@ examples: fileStorage.drivesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -7003,7 +7039,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.drivesOne: @@ -7058,7 +7094,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.drivesDelete: "": parameters: @@ -7081,7 +7117,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.driveGroupsAll: @@ -7113,6 +7149,7 @@ examples: fileStorage.driveGroupsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -7131,7 +7168,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.driveGroupsOne: @@ -7186,7 +7223,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} fileStorage.driveGroupsDelete: "": parameters: @@ -7209,7 +7246,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} hris.employeesAll: @@ -7242,6 +7279,7 @@ examples: hris.employeesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -7258,11 +7296,11 @@ examples: "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": - application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} + application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} hris.employeesOne: "": parameters: @@ -7302,7 +7340,7 @@ examples: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" x-apideck-service-id: "salesforce" requestBody: - application/json: {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "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"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": []}], "social_links": [{"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"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "pass_through": [{"service_id": "", "extend_paths": []}]} + application/json: {"id": "12345", "first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "display_name": "Technoking", "preferred_name": "Elon Musk", "initials": "EM", "salutation": "Mr", "title": "CEO", "marital_status": "married", "partner": {"first_name": "Elon", "last_name": "Musk", "middle_name": "D.", "gender": "male", "initials": "EM", "birthday": "2000-08-12", "deceased_on": "2000-08-12"}, "division": "Europe", "division_id": "12345", "department_id": "12345", "department_name": "12345", "team": {"id": "1234", "name": "Full Stack Engineers"}, "company_id": "23456", "company_name": "SpaceX", "employment_start_date": "2021-10-26", "employment_end_date": "2028-10-26", "leaving_reason": "resigned", "employee_number": "123456-AB", "employment_status": "active", "ethnicity": "African American", "manager": {"id": "12345", "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "email": "elon@musk.com", "employment_status": "active"}, "direct_reports": ["a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6"], "social_security_number": "123456789", "birthday": "2000-08-12", "deceased_on": "2000-08-12", "country_of_birth": "US", "description": "A description", "gender": "male", "pronouns": "she,her", "preferred_language": "EN", "languages": ["EN"], "nationalities": ["US"], "photo_url": "https://unavatar.io/elon-musk", "timezone": "Europe/London", "source": "lever", "source_id": "12345", "record_url": "https://app.intercom.io/contacts/12345", "jobs": [{"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}, {"title": "CEO", "role": "Sales", "start_date": "2020-08-12", "end_date": "2020-08-12", "compensation_rate": 72000, "currency": "USD", "payment_unit": "year", "hired_at": "2020-08-12", "is_primary": true, "is_manager": true, "status": "active", "location": {"id": "123", "type": "primary", "string": "25 Spring Street, Blackburn, VIC 3130", "name": "HQ US", "line1": "Main street", "line2": "apt #", "line3": "Suite #", "line4": "delivery instructions", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}}], "compensations": [{"rate": 50, "payment_unit": "hour", "flsa_status": "nonexempt", "effective_date": "2021-06-11"}], "works_remote": true, "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "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", "street_number": "25", "city": "San Francisco", "state": "CA", "postal_code": "94104", "country": "US", "latitude": "40.759211", "longitude": "-73.984638", "county": "Santa Clara", "contact_name": "Elon Musk", "salutation": "Mr", "phone_number": "111-111-1111", "fax": "122-111-1111", "email": "elon@musk.com", "website": "https://elonmusk.com", "notes": "Address notes or delivery instructions.", "row_version": "1-12345"}], "phone_numbers": [{"id": "12345", "country_code": "1", "area_code": "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"}], "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": true}, {"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": {}}], "social_links": [{"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"}], "bank_accounts": [{"bank_name": "Monzo", "account_number": "123465", "account_name": "SPACEX LLC", "account_type": "credit_card", "iban": "CH2989144532982975332", "bic": "AUDSCHGGXXX", "routing_number": "012345678", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "currency": "USD"}], "tax_code": "1111", "tax_id": "234-32-0000", "dietary_preference": "Veggie", "food_allergies": ["No allergies"], "probation_period": {"start_date": "2021-10-01", "end_date": "2021-11-28"}, "tags": ["New"], "row_version": "1-12345", "deleted": true, "pass_through": [{"service_id": "", "extend_paths": []}]} responses: "200": application/json: {"status_code": 200, "status": "OK", "service": "sage-hr", "resource": "Employees", "operation": "update", "data": {"id": "12345"}} @@ -7340,7 +7378,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} hris.companiesAll: @@ -7371,6 +7409,7 @@ examples: hris.companiesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -7381,7 +7420,7 @@ examples: "201": application/json: {"status_code": 200, "status": "OK", "service": "undefined", "resource": "Companies", "operation": "add", "data": {"id": "12345"}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": @@ -7467,7 +7506,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} hris.departmentsAll: @@ -7498,6 +7537,7 @@ examples: hris.departmentsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -7516,7 +7556,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} hris.departmentsOne: @@ -7571,7 +7611,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} hris.departmentsDelete: "": parameters: @@ -7594,7 +7634,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} hris.payrollsAll: @@ -7760,6 +7800,7 @@ examples: hris.timeOffRequestsAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -7778,7 +7819,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} hris.timeOffRequestsOne: @@ -7835,7 +7876,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} hris.timeOffRequestsDelete: "": parameters: @@ -7859,7 +7900,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} sms.messagesAll: @@ -7889,6 +7930,7 @@ examples: sms.messagesAdd: "": parameters: + query: {} header: x-apideck-consumer-id: "test-consumer" x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" @@ -7907,7 +7949,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} sms.messagesOne: @@ -7962,7 +8004,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} sms.messagesDelete: "": parameters: @@ -7985,7 +8027,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} issueTracking.collectionsAll: @@ -8087,7 +8129,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -8150,7 +8192,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} issueTracking.collectionTicketsDelete: "": parameters: @@ -8174,7 +8216,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} issueTracking.collectionTicketCommentsAll: @@ -8231,7 +8273,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} issueTracking.collectionTicketCommentsOne: @@ -8290,7 +8332,7 @@ examples: "422": application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} issueTracking.collectionTicketCommentsDelete: "": parameters: @@ -8315,7 +8357,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} issueTracking.collectionUsersAll: @@ -8560,7 +8602,7 @@ examples: "200": application/json: {"status_code": 200, "status": "OK", "data": {"consumer_id": "test_consumer_id", "application_id": "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", "metadata": {"account_name": "SpaceX", "user_name": "Elon Musk", "email": "elon@musk.com", "image": "https://www.spacex.com/static/images/share.jpg"}, "connections": [{"id": "1111+test_user_id", "name": "Salesforce", "icon": "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png", "logo": "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg", "website": "https://www.salesforce.com", "tag_line": "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.", "service_id": "teamleader", "unified_api": "crm", "consumer_id": "test_user_id", "auth_type": "oauth2", "enabled": true, "metadata": {"account": {"name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a"}, "plan": "enterprise"}, "created_at": "2020-09-19T12:18:37.071Z", "updated_at": "2020-09-19T12:18:37.071Z", "state": "authorized"}], "services": ["salesforce", "stripe"], "aggregated_request_count": 101, "request_counts": {"unify": 100, "proxy": 10, "vault": 21}, "created": "2021-05-07T12:55:42.242Z", "modified": "2021-05-07T12:55:42.242Z", "request_count_updated": "2021-05-07T12:55:42.242Z"}} "400": - application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} + application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": @@ -8574,6 +8616,7 @@ examples: vault.consumersAll: "": parameters: + query: {} header: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" responses: @@ -8634,7 +8677,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} vault.consumersDelete: @@ -8656,7 +8699,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} vault.consumerRequestCountsAll: @@ -8777,7 +8820,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} vault.connectionsImport: @@ -8821,7 +8864,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -8845,7 +8888,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -8871,7 +8914,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -9024,7 +9067,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -9059,6 +9102,7 @@ examples: webhook.webhooksAll: "": parameters: + query: {} header: x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" responses: @@ -9089,7 +9133,7 @@ examples: "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": - application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} + application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"} "402": application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"} "404": @@ -9141,7 +9185,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} webhook.webhooksDelete: @@ -9163,7 +9207,7 @@ examples: "404": application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"} "422": - application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"} + application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"} default: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"} webhook.eventLogsAll: diff --git a/.speakeasy/overlay-spec.yaml b/.speakeasy/overlay-spec.yaml new file mode 100644 index 0000000..2607fac --- /dev/null +++ b/.speakeasy/overlay-spec.yaml @@ -0,0 +1,8 @@ +overlay: 1.0.0 +info: + title: Format Parameter Name Update + version: 0.0.1 +actions: + - target: $["components"]["parameters"]["format"] + update: + name: file_format \ No newline at end of file diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index e8a907a..f5e2e10 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.453.0 +speakeasyVersion: 1.453.8 sources: Apideck: sourceNamespace: apideck - sourceRevisionDigest: sha256:bd31296f2b3ce64ae294b0e2921db4689f713fe0896e51a38dcaded2676414e6 - sourceBlobDigest: sha256:c78223a6f6e3fb5b1d9f0d663d8bd72bf35ecc3ed8435dd81561c45569a9f642 + sourceRevisionDigest: sha256:4370f91648df925a9cd5ee51f82e76448642303ca9fde1ea6aadf656bfe5694e + sourceBlobDigest: sha256:19939b73f05d1c30fba2779c43866e9c4d163b4e97a074b3a8961a34e04e5e8f tags: - latest - 10.8.3 @@ -11,10 +11,10 @@ targets: apideck: source: Apideck sourceNamespace: apideck - sourceRevisionDigest: sha256:bd31296f2b3ce64ae294b0e2921db4689f713fe0896e51a38dcaded2676414e6 - sourceBlobDigest: sha256:c78223a6f6e3fb5b1d9f0d663d8bd72bf35ecc3ed8435dd81561c45569a9f642 + sourceRevisionDigest: sha256:4370f91648df925a9cd5ee51f82e76448642303ca9fde1ea6aadf656bfe5694e + sourceBlobDigest: sha256:19939b73f05d1c30fba2779c43866e9c4d163b4e97a074b3a8961a34e04e5e8f codeSamplesNamespace: apideck-python-code-samples - codeSamplesRevisionDigest: sha256:9f12e8cc9d69d0ea4cbbd760a992e82f7a19a4744f9376bbfab9ea2b6843587c + codeSamplesRevisionDigest: sha256:3e9b2e781657df8ba931972b4537cab054eedda9568491c6d850f139a1b9c52b workflow: workflowVersion: 1.0.0 speakeasyVersion: latest @@ -22,12 +22,17 @@ workflow: Apideck: inputs: - location: https://ci-spec-unify.s3.eu-central-1.amazonaws.com/speakeasy-spec.yml + overlays: + - location: ./.speakeasy/overlay-spec.yaml registry: location: registry.speakeasyapi.dev/apideck-k2o/apideck/apideck targets: apideck: target: python source: Apideck + publish: + pypi: + token: $pypi_token codeSamples: registry: location: registry.speakeasyapi.dev/apideck-k2o/apideck/apideck-python-code-samples diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml index 67631be..66ee8ae 100644 --- a/.speakeasy/workflow.yaml +++ b/.speakeasy/workflow.yaml @@ -4,6 +4,8 @@ sources: Apideck: inputs: - location: https://ci-spec-unify.s3.eu-central-1.amazonaws.com/speakeasy-spec.yml + overlays: + - location: ./.speakeasy/overlay-spec.yaml registry: location: registry.speakeasyapi.dev/apideck-k2o/apideck/apideck targets: diff --git a/README.md b/README.md index f6db372..e16ba40 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ The SDK can be installed with either *pip* or *poetry* package managers. *PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line. ```bash -pip install git+.git +pip install apideck-unify ``` ### Poetry @@ -60,7 +60,7 @@ pip install git+.git *Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies. ```bash -poetry add git+.git +poetry add apideck-unify ``` @@ -88,8 +88,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.list(request={ +) as apideck: + res = apideck.accounting.tax_rates.list(request={ "service_id": "salesforce", "filter_": { "assets": True, @@ -123,8 +123,8 @@ async def main(): api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", - ) as s: - res = await s.accounting.tax_rates.list_async(request={ + ) as apideck: + res = await apideck.accounting.tax_rates.list_async(request={ "service_id": "salesforce", "filter_": { "assets": True, @@ -167,8 +167,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.list(request={ +) as apideck: + res = apideck.accounting.tax_rates.list(request={ "service_id": "salesforce", "filter_": { "assets": True, @@ -724,16 +724,16 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call: ```python -from apideck.utils import BackoffStrategy, RetryConfig from apideck_unify import Apideck +from apideck_unify.utils import BackoffStrategy, RetryConfig import os with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.list(request={ +) as apideck: + res = apideck.accounting.tax_rates.list(request={ "service_id": "salesforce", "filter_": { "assets": True, @@ -757,8 +757,8 @@ with Apideck( If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK: ```python -from apideck.utils import BackoffStrategy, RetryConfig from apideck_unify import Apideck +from apideck_unify.utils import BackoffStrategy, RetryConfig import os with Apideck( @@ -766,8 +766,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.list(request={ +) as apideck: + res = apideck.accounting.tax_rates.list(request={ "service_id": "salesforce", "filter_": { "assets": True, @@ -824,10 +824,10 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: +) as apideck: res = None try: - res = s.accounting.tax_rates.list(request={ + res = apideck.accounting.tax_rates.list(request={ "service_id": "salesforce", "filter_": { "assets": True, @@ -882,8 +882,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.list(request={ +) as apideck: + res = apideck.accounting.tax_rates.list(request={ "service_id": "salesforce", "filter_": { "assets": True, @@ -915,8 +915,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.upload_sessions.create(create_upload_session_request={ +) as apideck: + res = apideck.file_storage.upload_sessions.create(create_upload_session_request={ "name": "Documents", "parent_folder_id": "1234", "size": 1810673, diff --git a/USAGE.md b/USAGE.md index 6b180ca..3897ae4 100644 --- a/USAGE.md +++ b/USAGE.md @@ -8,8 +8,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.list(request={ +) as apideck: + res = apideck.accounting.tax_rates.list(request={ "service_id": "salesforce", "filter_": { "assets": True, @@ -43,8 +43,8 @@ async def main(): api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", - ) as s: - res = await s.accounting.tax_rates.list_async(request={ + ) as apideck: + res = await apideck.accounting.tax_rates.list_async(request={ "service_id": "salesforce", "filter_": { "assets": True, diff --git a/docs/models/connectordoc.md b/docs/models/connectordoc.md index e301550..f3a8c39 100644 --- a/docs/models/connectordoc.md +++ b/docs/models/connectordoc.md @@ -8,5 +8,5 @@ | `id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 | | `name` | *Optional[str]* | :heavy_minus_sign: | Name of the doc. | connection | | `audience` | [Optional[models.Audience]](../models/audience.md) | :heavy_minus_sign: | Audience for the doc. | | -| `format` | [Optional[models.Format]](../models/format.md) | :heavy_minus_sign: | Format of the doc. | | +| `format_` | [Optional[models.Format]](../models/format_.md) | :heavy_minus_sign: | Format of the doc. | | | `url` | *Optional[str]* | :heavy_minus_sign: | Link to fetch the content of the doc. | https://unify.apideck.com/connector/connectors/workday/docs/consumer+connection | \ No newline at end of file diff --git a/docs/models/filestoragefilesexportrequest.md b/docs/models/filestoragefilesexportrequest.md index b3eb3a3..1d9252c 100644 --- a/docs/models/filestoragefilesexportrequest.md +++ b/docs/models/filestoragefilesexportrequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `format` | *str* | :heavy_check_mark: | File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. | pdf | +| `file_format` | *str* | :heavy_check_mark: | File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. | pdf | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | \ No newline at end of file diff --git a/docs/models/format.md b/docs/models/format_.md similarity index 100% rename from docs/models/format.md rename to docs/models/format_.md diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md index 590fe42..6fc4f05 100644 --- a/docs/sdks/activities/README.md +++ b/docs/sdks/activities/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.activities.list(request={ +) as apideck: + res = apideck.crm.activities.list(request={ "service_id": "salesforce", "filter_": { "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), @@ -86,8 +86,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.activities.create(activity={ +) as apideck: + res = apideck.crm.activities.create(activity={ "type": apideck_unify.ActivityType.MEETING, "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, @@ -235,8 +235,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.activities.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.crm.activities.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -284,8 +284,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.activities.update(id="", activity={ +) as apideck: + res = apideck.crm.activities.update(id="", activity={ "type": apideck_unify.ActivityType.MEETING, "activity_datetime": "2021-05-01T12:00:00.000Z", "duration_seconds": 1800, @@ -487,8 +487,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.activities.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.crm.activities.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/apideckcompanies/README.md b/docs/sdks/apideckcompanies/README.md index a977a07..53f07d9 100644 --- a/docs/sdks/apideckcompanies/README.md +++ b/docs/sdks/apideckcompanies/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.companies.list(request={ +) as apideck: + res = apideck.hris.companies.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -77,8 +77,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.companies.create(hris_company={ +) as apideck: + res = apideck.hris.companies.create(hris_company={ "legal_name": "SpaceX", "display_name": "SpaceX", "subdomain": "company", @@ -207,8 +207,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.companies.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.hris.companies.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -256,8 +256,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.companies.update(id="", hris_company={ +) as apideck: + res = apideck.hris.companies.update(id="", hris_company={ "legal_name": "SpaceX", "display_name": "SpaceX", "subdomain": "company", @@ -478,8 +478,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.companies.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.hris.companies.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/apideckcustomers/README.md b/docs/sdks/apideckcustomers/README.md index 325bf17..729ba9e 100644 --- a/docs/sdks/apideckcustomers/README.md +++ b/docs/sdks/apideckcustomers/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ecommerce.customers.list(request={ +) as apideck: + res = apideck.ecommerce.customers.list(request={ "service_id": "salesforce", "filter_": { "email": "elon@musk.com", @@ -77,8 +77,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ecommerce.customers.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.ecommerce.customers.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response diff --git a/docs/sdks/apideckdepartments/README.md b/docs/sdks/apideckdepartments/README.md index 718160f..e160f80 100644 --- a/docs/sdks/apideckdepartments/README.md +++ b/docs/sdks/apideckdepartments/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.departments.list(request={ +) as apideck: + res = apideck.hris.departments.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -76,8 +76,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.departments.create(department={ +) as apideck: + res = apideck.hris.departments.create(department={ "name": "R&D", "code": "2", "description": "R&D", @@ -150,8 +150,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.departments.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.hris.departments.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -198,8 +198,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.departments.update(id="", department={ +) as apideck: + res = apideck.hris.departments.update(id="", department={ "name": "R&D", "code": "2", "description": "R&D", @@ -315,8 +315,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.departments.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.hris.departments.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/apiresourcecoveragesdk/README.md b/docs/sdks/apiresourcecoveragesdk/README.md index 0f68aac..ba6dab7 100644 --- a/docs/sdks/apiresourcecoveragesdk/README.md +++ b/docs/sdks/apiresourcecoveragesdk/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.connector.api_resource_coverage.get(id="", resource_id="") +) as apideck: + res = apideck.connector.api_resource_coverage.get(id="", resource_id="") if res is not None: # handle response diff --git a/docs/sdks/apiresources/README.md b/docs/sdks/apiresources/README.md index 26d0bad..2f38dc8 100644 --- a/docs/sdks/apiresources/README.md +++ b/docs/sdks/apiresources/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.connector.api_resources.get(id="", resource_id="") +) as apideck: + res = apideck.connector.api_resources.get(id="", resource_id="") if res is not None: # handle response diff --git a/docs/sdks/apis/README.md b/docs/sdks/apis/README.md index 21b0474..a402368 100644 --- a/docs/sdks/apis/README.md +++ b/docs/sdks/apis/README.md @@ -23,8 +23,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.connector.apis.list(filter_={ +) as apideck: + res = apideck.connector.apis.list(filter_={ "status": apideck_unify.APIStatus.BETA, }) @@ -70,8 +70,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.connector.apis.get(id="") +) as apideck: + res = apideck.connector.apis.get(id="") if res is not None: # handle response diff --git a/docs/sdks/applicants/README.md b/docs/sdks/applicants/README.md index 2acf314..4cf0d64 100644 --- a/docs/sdks/applicants/README.md +++ b/docs/sdks/applicants/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.applicants.list(request={ +) as apideck: + res = apideck.ats.applicants.list(request={ "service_id": "salesforce", "filter_": { "job_id": "1234", @@ -81,8 +81,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.applicants.create(applicant={ +) as apideck: + res = apideck.ats.applicants.create(applicant={ "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", @@ -316,8 +316,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.applicants.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.ats.applicants.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -366,8 +366,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.applicants.update(id="", applicant={ +) as apideck: + res = apideck.ats.applicants.update(id="", applicant={ "name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", @@ -611,8 +611,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.applicants.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.ats.applicants.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/applications/README.md b/docs/sdks/applications/README.md index 94f6d45..992a2bb 100644 --- a/docs/sdks/applications/README.md +++ b/docs/sdks/applications/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.applications.list(request={ +) as apideck: + res = apideck.ats.applications.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -76,8 +76,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.applications.create(application={ +) as apideck: + res = apideck.ats.applications.create(application={ "applicant_id": "12345", "job_id": "12345", "status": apideck_unify.ApplicationStatus.OPEN, @@ -154,8 +154,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.applications.get(id="", service_id="salesforce") +) as apideck: + res = apideck.ats.applications.get(id="", service_id="salesforce") if res is not None: # handle response @@ -202,8 +202,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.applications.update(id="", application={ +) as apideck: + res = apideck.ats.applications.update(id="", application={ "applicant_id": "12345", "job_id": "12345", "status": apideck_unify.ApplicationStatus.OPEN, @@ -323,8 +323,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.applications.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.ats.applications.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/attachments/README.md b/docs/sdks/attachments/README.md index 4819b88..1ec902e 100644 --- a/docs/sdks/attachments/README.md +++ b/docs/sdks/attachments/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.attachments.list(request={ +) as apideck: + res = apideck.accounting.attachments.list(request={ "reference_type": apideck_unify.AttachmentReferenceType.INVOICE, "reference_id": "123456", "service_id": "salesforce", @@ -76,8 +76,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.attachments.get(request={ +) as apideck: + res = apideck.accounting.attachments.get(request={ "reference_type": apideck_unify.AttachmentReferenceType.INVOICE, "reference_id": "123456", "id": "", @@ -128,8 +128,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.attachments.delete(request={ +) as apideck: + res = apideck.accounting.attachments.delete(request={ "reference_type": apideck_unify.AttachmentReferenceType.INVOICE, "reference_id": "123456", "id": "", @@ -179,8 +179,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.attachments.download(request={ +) as apideck: + res = apideck.accounting.attachments.download(request={ "reference_type": apideck_unify.AttachmentReferenceType.INVOICE, "reference_id": "123456", "id": "", diff --git a/docs/sdks/balancesheetsdk/README.md b/docs/sdks/balancesheetsdk/README.md index cda1188..b2d6bd5 100644 --- a/docs/sdks/balancesheetsdk/README.md +++ b/docs/sdks/balancesheetsdk/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.balance_sheet.get(service_id="salesforce", pass_through={ +) as apideck: + res = apideck.accounting.balance_sheet.get(service_id="salesforce", pass_through={ "search": "San Francisco", }, filter_={ "start_date": "2021-01-01", diff --git a/docs/sdks/billpayments/README.md b/docs/sdks/billpayments/README.md index 829aeaf..f7cbe8f 100644 --- a/docs/sdks/billpayments/README.md +++ b/docs/sdks/billpayments/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.bill_payments.list(request={ +) as apideck: + res = apideck.accounting.bill_payments.list(request={ "service_id": "salesforce", "filter_": { "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), @@ -87,8 +87,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.bill_payments.create(bill_payment={ +) as apideck: + res = apideck.accounting.bill_payments.create(bill_payment={ "total_amount": 49.99, "transaction_date": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), "currency": apideck_unify.Currency.USD, @@ -227,8 +227,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.bill_payments.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.bill_payments.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -277,8 +277,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.bill_payments.update(id="", bill_payment={ +) as apideck: + res = apideck.accounting.bill_payments.update(id="", bill_payment={ "total_amount": 49.99, "transaction_date": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), "currency": apideck_unify.Currency.USD, @@ -445,8 +445,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.bill_payments.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.bill_payments.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/bills/README.md b/docs/sdks/bills/README.md index 5412336..d73210d 100644 --- a/docs/sdks/bills/README.md +++ b/docs/sdks/bills/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.bills.list(request={ +) as apideck: + res = apideck.accounting.bills.list(request={ "service_id": "salesforce", "filter_": { "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), @@ -87,8 +87,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.bills.create(bill={ +) as apideck: + res = apideck.accounting.bills.create(bill={ "bill_number": "10001", "supplier": { "id": "12345", @@ -273,8 +273,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.bills.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.bills.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -323,8 +323,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.bills.update(id="", bill={ +) as apideck: + res = apideck.accounting.bills.update(id="", bill={ "bill_number": "10001", "supplier": { "id": "12345", @@ -612,8 +612,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.bills.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.bills.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/collections/README.md b/docs/sdks/collections/README.md index 7616506..1e9f070 100644 --- a/docs/sdks/collections/README.md +++ b/docs/sdks/collections/README.md @@ -23,8 +23,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collections.list(request={ +) as apideck: + res = apideck.issue_tracking.collections.list(request={ "service_id": "salesforce", "sort": { "by": apideck_unify.CollectionsSortBy.NAME, @@ -78,8 +78,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collections.get(collection_id="apideck-io", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.issue_tracking.collections.get(collection_id="apideck-io", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response diff --git a/docs/sdks/collectiontags/README.md b/docs/sdks/collectiontags/README.md index 0d95de1..f7178d7 100644 --- a/docs/sdks/collectiontags/README.md +++ b/docs/sdks/collectiontags/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_tags.list(request={ +) as apideck: + res = apideck.issue_tracking.collection_tags.list(request={ "collection_id": "apideck-io", "service_id": "salesforce", "pass_through": { diff --git a/docs/sdks/collectionticketcomments/README.md b/docs/sdks/collectionticketcomments/README.md index f1d5cac..9ecf918 100644 --- a/docs/sdks/collectionticketcomments/README.md +++ b/docs/sdks/collectionticketcomments/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_ticket_comments.list(request={ +) as apideck: + res = apideck.issue_tracking.collection_ticket_comments.list(request={ "collection_id": "apideck-io", "ticket_id": "", "service_id": "salesforce", @@ -83,8 +83,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_ticket_comments.create(request={ +) as apideck: + res = apideck.issue_tracking.collection_ticket_comments.create(request={ "collection_id": "apideck-io", "ticket_id": "", "collection_ticket_comment": { @@ -158,8 +158,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_ticket_comments.get(request={ +) as apideck: + res = apideck.issue_tracking.collection_ticket_comments.get(request={ "id": "", "collection_id": "apideck-io", "ticket_id": "", @@ -209,8 +209,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_ticket_comments.update(request={ +) as apideck: + res = apideck.issue_tracking.collection_ticket_comments.update(request={ "id": "", "collection_id": "apideck-io", "ticket_id": "", @@ -327,8 +327,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_ticket_comments.delete(request={ +) as apideck: + res = apideck.issue_tracking.collection_ticket_comments.delete(request={ "id": "", "collection_id": "apideck-io", "ticket_id": "", diff --git a/docs/sdks/collectiontickets/README.md b/docs/sdks/collectiontickets/README.md index 1dc45cf..714b58e 100644 --- a/docs/sdks/collectiontickets/README.md +++ b/docs/sdks/collectiontickets/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_tickets.list(request={ +) as apideck: + res = apideck.issue_tracking.collection_tickets.list(request={ "collection_id": "apideck-io", "service_id": "salesforce", "sort": { @@ -89,8 +89,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_tickets.create(collection_id="apideck-io", ticket={ +) as apideck: + res = apideck.issue_tracking.collection_tickets.create(collection_id="apideck-io", ticket={ "parent_id": "12345", "type": "Technical", "subject": "Technical Support Request", @@ -173,8 +173,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_tickets.get(request={ +) as apideck: + res = apideck.issue_tracking.collection_tickets.get(request={ "ticket_id": "", "collection_id": "apideck-io", "service_id": "salesforce", @@ -225,8 +225,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_tickets.update(request={ +) as apideck: + res = apideck.issue_tracking.collection_tickets.update(request={ "ticket_id": "", "collection_id": "apideck-io", "ticket": { @@ -333,8 +333,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_tickets.delete(ticket_id="", collection_id="apideck-io", service_id="salesforce") +) as apideck: + res = apideck.issue_tracking.collection_tickets.delete(ticket_id="", collection_id="apideck-io", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/collectionusers/README.md b/docs/sdks/collectionusers/README.md index ef9d6bb..5fb21e8 100644 --- a/docs/sdks/collectionusers/README.md +++ b/docs/sdks/collectionusers/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_users.list(request={ +) as apideck: + res = apideck.issue_tracking.collection_users.list(request={ "collection_id": "apideck-io", "service_id": "salesforce", "pass_through": { @@ -74,8 +74,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.issue_tracking.collection_users.get(request={ +) as apideck: + res = apideck.issue_tracking.collection_users.get(request={ "collection_id": "apideck-io", "id": "", "service_id": "salesforce", diff --git a/docs/sdks/companies/README.md b/docs/sdks/companies/README.md index e3e8ab3..438987a 100644 --- a/docs/sdks/companies/README.md +++ b/docs/sdks/companies/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.companies.list(request={ +) as apideck: + res = apideck.crm.companies.list(request={ "service_id": "salesforce", "filter_": { "name": "SpaceX", @@ -86,8 +86,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.companies.create(company={ +) as apideck: + res = apideck.crm.companies.create(company={ "name": "SpaceX", "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", @@ -353,8 +353,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.companies.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.crm.companies.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -403,8 +403,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.companies.update(id="", company={ +) as apideck: + res = apideck.crm.companies.update(id="", company={ "name": "SpaceX", "owner_id": "12345", "image": "https://www.spacex.com/static/images/share.jpg", @@ -638,8 +638,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.companies.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.crm.companies.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/companyinfosdk/README.md b/docs/sdks/companyinfosdk/README.md index 19b900a..6233c74 100644 --- a/docs/sdks/companyinfosdk/README.md +++ b/docs/sdks/companyinfosdk/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.company_info.get(service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.company_info.get(service_id="salesforce", fields="id,updated_at") if res is not None: # handle response diff --git a/docs/sdks/connectioncustommappings/README.md b/docs/sdks/connectioncustommappings/README.md index a9511f9..efd4797 100644 --- a/docs/sdks/connectioncustommappings/README.md +++ b/docs/sdks/connectioncustommappings/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.connection_custom_mappings.list(unified_api="crm", service_id="pipedrive", resource="leads", resource_id="1234") +) as apideck: + res = apideck.vault.connection_custom_mappings.list(unified_api="crm", service_id="pipedrive", resource="leads", resource_id="1234") if res is not None: # handle response diff --git a/docs/sdks/connections/README.md b/docs/sdks/connections/README.md index 64b1f37..94cf39e 100644 --- a/docs/sdks/connections/README.md +++ b/docs/sdks/connections/README.md @@ -29,8 +29,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.connections.list(api="crm", configured=True) +) as apideck: + res = apideck.vault.connections.list(api="crm", configured=True) if res is not None: # handle response @@ -75,8 +75,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.connections.get(service_id="pipedrive", unified_api="crm") +) as apideck: + res = apideck.vault.connections.get(service_id="pipedrive", unified_api="crm") if res is not None: # handle response @@ -121,8 +121,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.connections.update(service_id="pipedrive", unified_api="crm", connection={ +) as apideck: + res = apideck.vault.connections.update(service_id="pipedrive", unified_api="crm", connection={ "enabled": True, "settings": { "instance_url": "https://eu28.salesforce.com", @@ -344,8 +344,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.connections.delete(service_id="pipedrive", unified_api="crm") +) as apideck: + res = apideck.vault.connections.delete(service_id="pipedrive", unified_api="crm") if res is not None: # handle response @@ -391,8 +391,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.connections.imports(service_id="pipedrive", unified_api="crm", connection_import_data={ +) as apideck: + res = apideck.vault.connections.imports(service_id="pipedrive", unified_api="crm", connection_import_data={ "credentials": { "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.cThIIoDvwdueQB468K5xDc5633seEFoqwxjF_xSJyQQ", "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", @@ -456,8 +456,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.connections.token(service_id="pipedrive", unified_api="crm") +) as apideck: + res = apideck.vault.connections.token(service_id="pipedrive", unified_api="crm") if res is not None: # handle response diff --git a/docs/sdks/connectionsettings/README.md b/docs/sdks/connectionsettings/README.md index 3a116de..bf45d12 100644 --- a/docs/sdks/connectionsettings/README.md +++ b/docs/sdks/connectionsettings/README.md @@ -23,8 +23,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.connection_settings.list(unified_api="crm", service_id="pipedrive", resource="leads") +) as apideck: + res = apideck.vault.connection_settings.list(unified_api="crm", service_id="pipedrive", resource="leads") if res is not None: # handle response @@ -70,8 +70,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.connection_settings.update(service_id="pipedrive", unified_api="crm", resource="leads", connection={ +) as apideck: + res = apideck.vault.connection_settings.update(service_id="pipedrive", unified_api="crm", resource="leads", connection={ "enabled": True, "settings": { "instance_url": "https://eu28.salesforce.com", diff --git a/docs/sdks/connectordocs/README.md b/docs/sdks/connectordocs/README.md index c6d4406..0f5229f 100644 --- a/docs/sdks/connectordocs/README.md +++ b/docs/sdks/connectordocs/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.connector.connector_docs.get(id="", doc_id="application_owner+oauth_credentials") +) as apideck: + res = apideck.connector.connector_docs.get(id="", doc_id="application_owner+oauth_credentials") if res is not None: # handle response diff --git a/docs/sdks/connectorresources/README.md b/docs/sdks/connectorresources/README.md index a8323e3..e4c71d8 100644 --- a/docs/sdks/connectorresources/README.md +++ b/docs/sdks/connectorresources/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.connector.connector_resources.get(id="", resource_id="", unified_api=apideck_unify.UnifiedAPIID.CRM) +) as apideck: + res = apideck.connector.connector_resources.get(id="", resource_id="", unified_api=apideck_unify.UnifiedAPIID.CRM) if res is not None: # handle response diff --git a/docs/sdks/connectors/README.md b/docs/sdks/connectors/README.md index 43093ac..af7cdde 100644 --- a/docs/sdks/connectors/README.md +++ b/docs/sdks/connectors/README.md @@ -23,8 +23,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.connector.connectors.list(filter_={ +) as apideck: + res = apideck.connector.connectors.list(filter_={ "unified_api": apideck_unify.UnifiedAPIID.FILE_STORAGE, }) @@ -70,8 +70,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.connector.connectors.get(id="") +) as apideck: + res = apideck.connector.connectors.get(id="") if res is not None: # handle response diff --git a/docs/sdks/consumerrequestcounts/README.md b/docs/sdks/consumerrequestcounts/README.md index 8525085..b0bafcd 100644 --- a/docs/sdks/consumerrequestcounts/README.md +++ b/docs/sdks/consumerrequestcounts/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.consumer_request_counts.list(consumer_id="test_user_id", start_datetime="2021-05-01T12:00:00.000Z", end_datetime="2021-05-30T12:00:00.000Z") +) as apideck: + res = apideck.vault.consumer_request_counts.list(consumer_id="test_user_id", start_datetime="2021-05-01T12:00:00.000Z", end_datetime="2021-05-30T12:00:00.000Z") if res is not None: # handle response diff --git a/docs/sdks/consumers/README.md b/docs/sdks/consumers/README.md index 6819368..f880d38 100644 --- a/docs/sdks/consumers/README.md +++ b/docs/sdks/consumers/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.consumers.create(request={ +) as apideck: + res = apideck.vault.consumers.create(request={ "consumer_id": "test_consumer_id", "metadata": { "account_name": "SpaceX", @@ -79,8 +79,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.consumers.list() +) as apideck: + res = apideck.vault.consumers.list() if res is not None: # handle response @@ -126,8 +126,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.consumers.get(consumer_id="test_user_id") +) as apideck: + res = apideck.vault.consumers.get(consumer_id="test_user_id") if res is not None: # handle response @@ -171,8 +171,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.consumers.update(consumer_id="test_user_id", update_consumer_request={ +) as apideck: + res = apideck.vault.consumers.update(consumer_id="test_user_id", update_consumer_request={ "metadata": { "account_name": "SpaceX", "user_name": "Elon Musk", @@ -224,8 +224,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.consumers.delete(consumer_id="test_user_id") +) as apideck: + res = apideck.vault.consumers.delete(consumer_id="test_user_id") if res is not None: # handle response diff --git a/docs/sdks/contacts/README.md b/docs/sdks/contacts/README.md index 5899710..d119fcf 100644 --- a/docs/sdks/contacts/README.md +++ b/docs/sdks/contacts/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.contacts.list(request={ +) as apideck: + res = apideck.crm.contacts.list(request={ "service_id": "salesforce", "filter_": { "first_name": "Elon", @@ -89,8 +89,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.contacts.create(contact={ +) as apideck: + res = apideck.crm.contacts.create(contact={ "name": "Elon Musk", "owner_id": "54321", "type": apideck_unify.ContactType.PERSONAL, @@ -353,8 +353,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.contacts.get(request={ +) as apideck: + res = apideck.crm.contacts.get(request={ "id": "", "service_id": "salesforce", "fields": "id,updated_at", @@ -410,8 +410,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.contacts.update(id="", contact={ +) as apideck: + res = apideck.crm.contacts.update(id="", contact={ "name": "Elon Musk", "owner_id": "54321", "type": apideck_unify.ContactType.PERSONAL, @@ -654,8 +654,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.contacts.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.crm.contacts.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/createcallback/README.md b/docs/sdks/createcallback/README.md index 7d3f9ff..ba19063 100644 --- a/docs/sdks/createcallback/README.md +++ b/docs/sdks/createcallback/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.create_callback.state(service_id="pipedrive", unified_api="crm", create_callback_state={ +) as apideck: + res = apideck.vault.create_callback.state(service_id="pipedrive", unified_api="crm", create_callback_state={ "redirect_uri": "https://example.com/callback", }) diff --git a/docs/sdks/creditnotes/README.md b/docs/sdks/creditnotes/README.md index d740fe4..da62c94 100644 --- a/docs/sdks/creditnotes/README.md +++ b/docs/sdks/creditnotes/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.credit_notes.list(request={ +) as apideck: + res = apideck.accounting.credit_notes.list(request={ "service_id": "salesforce", "filter_": { "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), @@ -87,8 +87,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.credit_notes.create(credit_note={ +) as apideck: + res = apideck.accounting.credit_notes.create(credit_note={ "total_amount": 49.99, "number": "OIT00546", "customer": { @@ -390,8 +390,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.credit_notes.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.credit_notes.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -440,8 +440,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.credit_notes.update(id="", credit_note={ +) as apideck: + res = apideck.accounting.credit_notes.update(id="", credit_note={ "total_amount": 49.99, "number": "OIT00546", "customer": { @@ -814,8 +814,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.credit_notes.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.credit_notes.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/customers/README.md b/docs/sdks/customers/README.md index 9ca6cd0..d7dd700 100644 --- a/docs/sdks/customers/README.md +++ b/docs/sdks/customers/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.customers.list(request={ +) as apideck: + res = apideck.accounting.customers.list(request={ "service_id": "salesforce", "filter_": { "company_name": "SpaceX", @@ -92,8 +92,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.customers.create(customer={ +) as apideck: + res = apideck.accounting.customers.create(customer={ "display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", @@ -303,8 +303,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.customers.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.customers.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -352,8 +352,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.customers.update(id="", customer={ +) as apideck: + res = apideck.accounting.customers.update(id="", customer={ "display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", @@ -613,8 +613,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.customers.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.customers.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/customfields/README.md b/docs/sdks/customfields/README.md index 2cedeab..49cba71 100644 --- a/docs/sdks/customfields/README.md +++ b/docs/sdks/customfields/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.custom_fields.list(unified_api="crm", service_id="pipedrive", resource="leads", resource_id="1234") +) as apideck: + res = apideck.vault.custom_fields.list(unified_api="crm", service_id="pipedrive", resource="leads", resource_id="1234") if res is not None: # handle response diff --git a/docs/sdks/custommappingssdk/README.md b/docs/sdks/custommappingssdk/README.md index f47914f..f3ebd6e 100644 --- a/docs/sdks/custommappingssdk/README.md +++ b/docs/sdks/custommappingssdk/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.custom_mappings.list(unified_api="crm", service_id="pipedrive") +) as apideck: + res = apideck.vault.custom_mappings.list(unified_api="crm", service_id="pipedrive") if res is not None: # handle response diff --git a/docs/sdks/departments/README.md b/docs/sdks/departments/README.md index cb35011..6e0aedb 100644 --- a/docs/sdks/departments/README.md +++ b/docs/sdks/departments/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.departments.list(request={ +) as apideck: + res = apideck.accounting.departments.list(request={ "service_id": "salesforce", "fields": "id,updated_at", "filter_": { @@ -77,8 +77,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.departments.create(accounting_department={ +) as apideck: + res = apideck.accounting.departments.create(accounting_department={ "parent_id": "12345", "name": "Sales", "status": apideck_unify.DepartmentStatus.ACTIVE, @@ -162,8 +162,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.departments.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.departments.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -211,8 +211,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.departments.update(id="", accounting_department={ +) as apideck: + res = apideck.accounting.departments.update(id="", accounting_department={ "parent_id": "12345", "name": "Sales", "status": apideck_unify.DepartmentStatus.ACTIVE, @@ -319,8 +319,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.departments.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.departments.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/drivegroups/README.md b/docs/sdks/drivegroups/README.md index 82aa714..2deb269 100644 --- a/docs/sdks/drivegroups/README.md +++ b/docs/sdks/drivegroups/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.drive_groups.list(request={ +) as apideck: + res = apideck.file_storage.drive_groups.list(request={ "service_id": "salesforce", "filter_": { "parent_group_id": "1234", @@ -79,8 +79,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.drive_groups.create(drive_group={ +) as apideck: + res = apideck.file_storage.drive_groups.create(drive_group={ "name": "accounting", "display_name": "accounting", "description": "A description", @@ -153,8 +153,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.drive_groups.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.file_storage.drive_groups.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -201,8 +201,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.drive_groups.update(id="", drive_group={ +) as apideck: + res = apideck.file_storage.drive_groups.update(id="", drive_group={ "name": "accounting", "display_name": "accounting", "description": "A description", @@ -318,8 +318,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.drive_groups.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.file_storage.drive_groups.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/drives/README.md b/docs/sdks/drives/README.md index 36f71a5..cc1ab47 100644 --- a/docs/sdks/drives/README.md +++ b/docs/sdks/drives/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.drives.list(request={ +) as apideck: + res = apideck.file_storage.drives.list(request={ "service_id": "salesforce", "filter_": { "group_id": "1234", @@ -76,8 +76,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.drives.create(drive={ +) as apideck: + res = apideck.file_storage.drives.create(drive={ "name": "Project Resources", "description": "A description", "pass_through": [ @@ -149,8 +149,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.drives.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.file_storage.drives.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -197,8 +197,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.drives.update(id="", drive={ +) as apideck: + res = apideck.file_storage.drives.update(id="", drive={ "name": "Project Resources", "description": "A description", "pass_through": [ @@ -313,8 +313,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.drives.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.file_storage.drives.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/employeepayrolls/README.md b/docs/sdks/employeepayrolls/README.md index 6e487dd..6396d6d 100644 --- a/docs/sdks/employeepayrolls/README.md +++ b/docs/sdks/employeepayrolls/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.employee_payrolls.list(request={ +) as apideck: + res = apideck.hris.employee_payrolls.list(request={ "employee_id": "", "service_id": "salesforce", "filter_": { @@ -78,8 +78,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.employee_payrolls.get(request={ +) as apideck: + res = apideck.hris.employee_payrolls.get(request={ "payroll_id": "", "employee_id": "", "service_id": "salesforce", diff --git a/docs/sdks/employees/README.md b/docs/sdks/employees/README.md index 01cc023..4b511ee 100644 --- a/docs/sdks/employees/README.md +++ b/docs/sdks/employees/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.employees.list(request={ +) as apideck: + res = apideck.hris.employees.list(request={ "service_id": "salesforce", "filter_": { "company_id": "1234", @@ -94,8 +94,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.employees.create(employee={ +) as apideck: + res = apideck.hris.employees.create(employee={ "id": "12345", "first_name": "Elon", "last_name": "Musk", @@ -425,8 +425,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.employees.get(request={ +) as apideck: + res = apideck.hris.employees.get(request={ "id": "", "service_id": "salesforce", "fields": "id,updated_at", @@ -482,8 +482,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.employees.update(id="", employee={ +) as apideck: + res = apideck.hris.employees.update(id="", employee={ "id": "12345", "first_name": "Elon", "last_name": "Musk", @@ -882,8 +882,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.employees.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.hris.employees.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/employeeschedulessdk/README.md b/docs/sdks/employeeschedulessdk/README.md index aca6a29..fc81923 100644 --- a/docs/sdks/employeeschedulessdk/README.md +++ b/docs/sdks/employeeschedulessdk/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.employee_schedules.list(request={ +) as apideck: + res = apideck.hris.employee_schedules.list(request={ "employee_id": "", "service_id": "salesforce", "pass_through": { diff --git a/docs/sdks/eventlogs/README.md b/docs/sdks/eventlogs/README.md index 2373413..2803447 100644 --- a/docs/sdks/eventlogs/README.md +++ b/docs/sdks/eventlogs/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.webhook.event_logs.list(filter_={ +) as apideck: + res = apideck.webhook.event_logs.list(filter_={ "exclude_apis": "vault,proxy", "consumer_id": "test_user_id", "entity_type": "Connection", diff --git a/docs/sdks/expenses/README.md b/docs/sdks/expenses/README.md index c12d818..9baf2e2 100644 --- a/docs/sdks/expenses/README.md +++ b/docs/sdks/expenses/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.expenses.list(service_id="salesforce") +) as apideck: + res = apideck.accounting.expenses.list(service_id="salesforce") if res is not None: # handle response @@ -75,8 +75,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.expenses.create(expense={ +) as apideck: + res = apideck.accounting.expenses.create(expense={ "transaction_date": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), "account_id": "123456", "line_items": [ @@ -189,8 +189,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.expenses.get(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.expenses.get(id="", service_id="salesforce") if res is not None: # handle response @@ -238,8 +238,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.expenses.update(id="", expense={ +) as apideck: + res = apideck.accounting.expenses.update(id="", expense={ "transaction_date": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), "account_id": "123456", "line_items": [ @@ -431,8 +431,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.expenses.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.expenses.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/files/README.md b/docs/sdks/files/README.md index 18bda9e..e8ddef5 100644 --- a/docs/sdks/files/README.md +++ b/docs/sdks/files/README.md @@ -28,8 +28,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.files.list(request={ +) as apideck: + res = apideck.file_storage.files.list(request={ "service_id": "salesforce", "filter_": { "drive_id": "1234", @@ -88,8 +88,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.files.search(request={ +) as apideck: + res = apideck.file_storage.files.search(request={ "files_search": { "query": "logo jpg", }, @@ -147,8 +147,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.files.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.file_storage.files.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -195,8 +195,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.files.update(id="", update_file_request={ +) as apideck: + res = apideck.file_storage.files.update(id="", update_file_request={ "name": "New Name.pdf", "description": "Renamed PDF Document", "parent_folder_id": "1234", @@ -312,8 +312,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.files.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.file_storage.files.delete(id="", service_id="salesforce") if res is not None: # handle response @@ -359,8 +359,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.files.download(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.file_storage.files.download(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -406,8 +406,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.files.export(id="", format="pdf", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.file_storage.files.export(id="", file_format="pdf", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -420,7 +420,7 @@ with Apideck( | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | | -| `format` | *str* | :heavy_check_mark: | File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. | pdf | +| `file_format` | *str* | :heavy_check_mark: | File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. | pdf | | `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | | `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/docs/sdks/folders/README.md b/docs/sdks/folders/README.md index 3e9a2fc..f7e6576 100644 --- a/docs/sdks/folders/README.md +++ b/docs/sdks/folders/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.folders.create(create_folder_request={ +) as apideck: + res = apideck.file_storage.folders.create(create_folder_request={ "name": "Documents", "parent_folder_id": "1234", "description": "My Personal Documents", @@ -101,8 +101,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.folders.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.file_storage.folders.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -149,8 +149,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.folders.update(id="", update_folder_request={ +) as apideck: + res = apideck.file_storage.folders.update(id="", update_folder_request={ "name": "Documents", "description": "My Personal Documents", "parent_folder_id": "1234", @@ -266,8 +266,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.folders.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.file_storage.folders.delete(id="", service_id="salesforce") if res is not None: # handle response @@ -313,8 +313,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.folders.copy(request={ +) as apideck: + res = apideck.file_storage.folders.copy(request={ "id": "", "copy_folder_request": { "parent_folder_id": "1234", diff --git a/docs/sdks/invoiceitems/README.md b/docs/sdks/invoiceitems/README.md index 8042701..9313caa 100644 --- a/docs/sdks/invoiceitems/README.md +++ b/docs/sdks/invoiceitems/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.invoice_items.list(request={ +) as apideck: + res = apideck.accounting.invoice_items.list(request={ "service_id": "salesforce", "filter_": { "name": "Widgets Large", @@ -83,8 +83,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.invoice_items.create(invoice_item={ +) as apideck: + res = apideck.accounting.invoice_items.create(invoice_item={ "name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", @@ -212,8 +212,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.invoice_items.get(request={ +) as apideck: + res = apideck.accounting.invoice_items.get(request={ "id": "", "service_id": "salesforce", "fields": "id,updated_at", @@ -266,8 +266,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.invoice_items.update(id="", invoice_item={ +) as apideck: + res = apideck.accounting.invoice_items.update(id="", invoice_item={ "name": "Model Y", "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", "code": "120-C", @@ -419,8 +419,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.invoice_items.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.invoice_items.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/invoices/README.md b/docs/sdks/invoices/README.md index ab6f74b..d4a2054 100644 --- a/docs/sdks/invoices/README.md +++ b/docs/sdks/invoices/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.invoices.list(request={ +) as apideck: + res = apideck.accounting.invoices.list(request={ "service_id": "salesforce", "filter_": { "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), @@ -89,8 +89,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.invoices.create(invoice={ +) as apideck: + res = apideck.accounting.invoices.create(invoice={ "type": apideck_unify.InvoiceType.SERVICE, "number": "OIT00546", "customer": { @@ -395,8 +395,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.invoices.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.invoices.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -445,8 +445,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.invoices.update(id="", invoice={ +) as apideck: + res = apideck.accounting.invoices.update(id="", invoice={ "type": apideck_unify.InvoiceType.SERVICE, "number": "OIT00546", "customer": { @@ -750,8 +750,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.invoices.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.invoices.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/jobs/README.md b/docs/sdks/jobs/README.md index ef003ce..435c579 100644 --- a/docs/sdks/jobs/README.md +++ b/docs/sdks/jobs/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.jobs.list(request={ +) as apideck: + res = apideck.ats.jobs.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -73,8 +73,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ats.jobs.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.ats.jobs.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response diff --git a/docs/sdks/journalentries/README.md b/docs/sdks/journalentries/README.md index 2d0a8ec..60d4c77 100644 --- a/docs/sdks/journalentries/README.md +++ b/docs/sdks/journalentries/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.journal_entries.list(request={ +) as apideck: + res = apideck.accounting.journal_entries.list(request={ "service_id": "salesforce", "filter_": { "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), @@ -87,8 +87,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.journal_entries.create(journal_entry={ +) as apideck: + res = apideck.accounting.journal_entries.create(journal_entry={ "title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", "currency_rate": 0.69, "currency": apideck_unify.Currency.USD, @@ -232,8 +232,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.journal_entries.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.journal_entries.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -282,8 +282,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.journal_entries.update(id="", journal_entry={ +) as apideck: + res = apideck.accounting.journal_entries.update(id="", journal_entry={ "title": "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry", "currency_rate": 0.69, "currency": apideck_unify.Currency.USD, @@ -572,8 +572,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.journal_entries.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.journal_entries.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/leads/README.md b/docs/sdks/leads/README.md index cf084a5..50d5f18 100644 --- a/docs/sdks/leads/README.md +++ b/docs/sdks/leads/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.leads.list(request={ +) as apideck: + res = apideck.crm.leads.list(request={ "service_id": "salesforce", "filter_": { "first_name": "Elon", @@ -88,8 +88,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.leads.create(lead={ +) as apideck: + res = apideck.crm.leads.create(lead={ "name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", @@ -342,8 +342,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.leads.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.crm.leads.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -391,8 +391,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.leads.update(id="", lead={ +) as apideck: + res = apideck.crm.leads.update(id="", lead={ "name": "Elon Musk", "company_name": "Spacex", "owner_id": "54321", @@ -625,8 +625,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.leads.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.crm.leads.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/ledgeraccounts/README.md b/docs/sdks/ledgeraccounts/README.md index c2d8344..fdb2cac 100644 --- a/docs/sdks/ledgeraccounts/README.md +++ b/docs/sdks/ledgeraccounts/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.ledger_accounts.list(request={ +) as apideck: + res = apideck.accounting.ledger_accounts.list(request={ "service_id": "salesforce", "filter_": { "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), @@ -87,8 +87,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.ledger_accounts.create(ledger_account={ +) as apideck: + res = apideck.accounting.ledger_accounts.create(ledger_account={ "display_id": "1-12345", "code": "453", "classification": apideck_unify.Classification.ASSET, @@ -199,8 +199,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.ledger_accounts.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.ledger_accounts.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -249,8 +249,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.ledger_accounts.update(id="", ledger_account={ +) as apideck: + res = apideck.accounting.ledger_accounts.update(id="", ledger_account={ "display_id": "1-12345", "code": "453", "classification": apideck_unify.Classification.ASSET, @@ -404,8 +404,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.ledger_accounts.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.ledger_accounts.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/locations/README.md b/docs/sdks/locations/README.md index ab066fa..f21484e 100644 --- a/docs/sdks/locations/README.md +++ b/docs/sdks/locations/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.locations.list(request={ +) as apideck: + res = apideck.accounting.locations.list(request={ "service_id": "salesforce", "fields": "id,updated_at", "filter_": { @@ -77,8 +77,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.locations.create(accounting_location={ +) as apideck: + res = apideck.accounting.locations.create(accounting_location={ "parent_id": "12345", "company_name": "SpaceX", "display_name": "11 UT - South Jordan", @@ -181,8 +181,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.locations.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.locations.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -230,8 +230,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.locations.update(id="", accounting_location={ +) as apideck: + res = apideck.accounting.locations.update(id="", accounting_location={ "parent_id": "12345", "company_name": "SpaceX", "display_name": "11 UT - South Jordan", @@ -403,8 +403,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.locations.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.locations.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/logs/README.md b/docs/sdks/logs/README.md index ef367d5..b2d3778 100644 --- a/docs/sdks/logs/README.md +++ b/docs/sdks/logs/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.logs.list(filter_={ +) as apideck: + res = apideck.vault.logs.list(filter_={ "connector_id": "crm+salesforce", "status_code": 201, "exclude_unified_apis": "vault,proxy", diff --git a/docs/sdks/messages/README.md b/docs/sdks/messages/README.md index fc62007..084563d 100644 --- a/docs/sdks/messages/README.md +++ b/docs/sdks/messages/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.sms.messages.list(request={ +) as apideck: + res = apideck.sms.messages.list(request={ "service_id": "salesforce", "fields": "id,updated_at", }) @@ -75,8 +75,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.sms.messages.create(message={ +) as apideck: + res = apideck.sms.messages.create(message={ "from_": "+15017122661", "to": "+15017122662", "body": "Hi! How are you doing?", @@ -155,8 +155,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.sms.messages.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.sms.messages.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -205,8 +205,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.sms.messages.update(id="", message={ +) as apideck: + res = apideck.sms.messages.update(id="", message={ "from_": "+15017122661", "to": "+15017122662", "body": "Hi! How are you doing?", @@ -328,8 +328,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.sms.messages.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.sms.messages.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/notes/README.md b/docs/sdks/notes/README.md index 82359b0..9e3a565 100644 --- a/docs/sdks/notes/README.md +++ b/docs/sdks/notes/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.notes.list(request={ +) as apideck: + res = apideck.crm.notes.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -76,8 +76,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.notes.create(note={ +) as apideck: + res = apideck.crm.notes.create(note={ "title": "Meeting Notes", "content": "Office hours are 9AM-6PM", "owner_id": "12345", @@ -155,8 +155,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.notes.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.crm.notes.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -203,8 +203,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.notes.update(id="", note={ +) as apideck: + res = apideck.crm.notes.update(id="", note={ "title": "Meeting Notes", "content": "Office hours are 9AM-6PM", "owner_id": "12345", @@ -325,8 +325,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.notes.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.crm.notes.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/opportunities/README.md b/docs/sdks/opportunities/README.md index af5b926..7e67291 100644 --- a/docs/sdks/opportunities/README.md +++ b/docs/sdks/opportunities/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.opportunities.list(request={ +) as apideck: + res = apideck.crm.opportunities.list(request={ "service_id": "salesforce", "filter_": { "status": "Completed", @@ -87,8 +87,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.opportunities.create(opportunity={ +) as apideck: + res = apideck.crm.opportunities.create(opportunity={ "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", @@ -188,8 +188,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.opportunities.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.crm.opportunities.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -238,8 +238,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.opportunities.update(id="", opportunity={ +) as apideck: + res = apideck.crm.opportunities.update(id="", opportunity={ "title": "New Rocket", "primary_contact_id": "12345", "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", @@ -367,8 +367,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.opportunities.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.crm.opportunities.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/orders/README.md b/docs/sdks/orders/README.md index 51bc01d..39dcc89 100644 --- a/docs/sdks/orders/README.md +++ b/docs/sdks/orders/README.md @@ -23,8 +23,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ecommerce.orders.list(request={ +) as apideck: + res = apideck.ecommerce.orders.list(request={ "service_id": "salesforce", "filter_": { "email": "elon@musk.com", @@ -84,8 +84,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ecommerce.orders.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.ecommerce.orders.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response diff --git a/docs/sdks/payments/README.md b/docs/sdks/payments/README.md index b57a005..801700e 100644 --- a/docs/sdks/payments/README.md +++ b/docs/sdks/payments/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.payments.list(request={ +) as apideck: + res = apideck.accounting.payments.list(request={ "service_id": "salesforce", "filter_": { "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), @@ -87,8 +87,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.payments.create(payment={ +) as apideck: + res = apideck.accounting.payments.create(payment={ "total_amount": 49.99, "transaction_date": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), "currency": apideck_unify.Currency.USD, @@ -201,8 +201,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.payments.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.payments.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -251,8 +251,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.payments.update(id="", payment={ +) as apideck: + res = apideck.accounting.payments.update(id="", payment={ "total_amount": 49.99, "transaction_date": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), "currency": apideck_unify.Currency.USD, @@ -391,8 +391,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.payments.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.payments.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/payrolls/README.md b/docs/sdks/payrolls/README.md index d4163e8..b233528 100644 --- a/docs/sdks/payrolls/README.md +++ b/docs/sdks/payrolls/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.payrolls.list(request={ +) as apideck: + res = apideck.hris.payrolls.list(request={ "service_id": "salesforce", "filter_": { "start_date": "2022-04-08", @@ -77,8 +77,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.payrolls.get(payroll_id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.hris.payrolls.get(payroll_id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response diff --git a/docs/sdks/pipelines/README.md b/docs/sdks/pipelines/README.md index 58f49e9..d73d809 100644 --- a/docs/sdks/pipelines/README.md +++ b/docs/sdks/pipelines/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.pipelines.list(request={ +) as apideck: + res = apideck.crm.pipelines.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -77,8 +77,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.pipelines.create(pipeline={ +) as apideck: + res = apideck.crm.pipelines.create(pipeline={ "name": "Sales Pipeline", "id": "default", "currency": apideck_unify.Currency.USD, @@ -168,8 +168,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.pipelines.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.crm.pipelines.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -217,8 +217,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.pipelines.update(id="", pipeline={ +) as apideck: + res = apideck.crm.pipelines.update(id="", pipeline={ "name": "Sales Pipeline", "id": "default", "currency": apideck_unify.Currency.USD, @@ -337,8 +337,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.pipelines.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.crm.pipelines.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/products/README.md b/docs/sdks/products/README.md index 7e2f985..bbed4cb 100644 --- a/docs/sdks/products/README.md +++ b/docs/sdks/products/README.md @@ -22,8 +22,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ecommerce.products.list(request={ +) as apideck: + res = apideck.ecommerce.products.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -73,8 +73,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ecommerce.products.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.ecommerce.products.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response diff --git a/docs/sdks/profitandlosssdk/README.md b/docs/sdks/profitandlosssdk/README.md index 6f0a4af..997e454 100644 --- a/docs/sdks/profitandlosssdk/README.md +++ b/docs/sdks/profitandlosssdk/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.profit_and_loss.get(request={ +) as apideck: + res = apideck.accounting.profit_and_loss.get(request={ "service_id": "salesforce", "filter_": { "customer_id": "123abc", diff --git a/docs/sdks/purchaseorders/README.md b/docs/sdks/purchaseorders/README.md index 77a852a..30ff429 100644 --- a/docs/sdks/purchaseorders/README.md +++ b/docs/sdks/purchaseorders/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.purchase_orders.list(request={ +) as apideck: + res = apideck.accounting.purchase_orders.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -87,8 +87,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.purchase_orders.create(purchase_order={ +) as apideck: + res = apideck.accounting.purchase_orders.create(purchase_order={ "po_number": "90000117", "reference": "123456", "supplier": { @@ -346,8 +346,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.purchase_orders.get(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.purchase_orders.get(id="", service_id="salesforce") if res is not None: # handle response @@ -395,8 +395,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.purchase_orders.update(id="", purchase_order={ +) as apideck: + res = apideck.accounting.purchase_orders.update(id="", purchase_order={ "po_number": "90000117", "reference": "123456", "supplier": { @@ -767,8 +767,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.purchase_orders.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.purchase_orders.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/sessions/README.md b/docs/sdks/sessions/README.md index 45d16ba..bba3311 100644 --- a/docs/sdks/sessions/README.md +++ b/docs/sdks/sessions/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.sessions.create(request={ +) as apideck: + res = apideck.vault.sessions.create(request={ "consumer_metadata": { "account_name": "SpaceX", "user_name": "Elon Musk", diff --git a/docs/sdks/sharedlinks/README.md b/docs/sdks/sharedlinks/README.md index f1c7eb1..9706f95 100644 --- a/docs/sdks/sharedlinks/README.md +++ b/docs/sdks/sharedlinks/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.shared_links.list(request={ +) as apideck: + res = apideck.file_storage.shared_links.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -77,8 +77,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.shared_links.create(shared_link={ +) as apideck: + res = apideck.file_storage.shared_links.create(shared_link={ "target_id": "", "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "scope": apideck_unify.Scope.COMPANY, @@ -151,8 +151,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.shared_links.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.file_storage.shared_links.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -200,8 +200,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.shared_links.update(id="", shared_link={ +) as apideck: + res = apideck.file_storage.shared_links.update(id="", shared_link={ "target_id": "", "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "scope": apideck_unify.Scope.COMPANY, @@ -317,8 +317,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.shared_links.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.file_storage.shared_links.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/stores/README.md b/docs/sdks/stores/README.md index 046ec57..efa84d0 100644 --- a/docs/sdks/stores/README.md +++ b/docs/sdks/stores/README.md @@ -21,8 +21,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.ecommerce.stores.get(service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.ecommerce.stores.get(service_id="salesforce", fields="id,updated_at") if res is not None: # handle response diff --git a/docs/sdks/subsidiaries/README.md b/docs/sdks/subsidiaries/README.md index 4c559d1..b2f608e 100644 --- a/docs/sdks/subsidiaries/README.md +++ b/docs/sdks/subsidiaries/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.subsidiaries.list(request={ +) as apideck: + res = apideck.accounting.subsidiaries.list(request={ "service_id": "salesforce", "fields": "id,updated_at", }) @@ -74,8 +74,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.subsidiaries.create(subsidiary={ +) as apideck: + res = apideck.accounting.subsidiaries.create(subsidiary={ "parent_id": "12345", "name": "SpaceX", "status": apideck_unify.SubsidiaryStatus.ACTIVE, @@ -149,8 +149,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.subsidiaries.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.subsidiaries.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -198,8 +198,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.subsidiaries.update(id="", subsidiary={ +) as apideck: + res = apideck.accounting.subsidiaries.update(id="", subsidiary={ "parent_id": "12345", "name": "SpaceX", "status": apideck_unify.SubsidiaryStatus.ACTIVE, @@ -316,8 +316,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.subsidiaries.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.subsidiaries.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/suppliers/README.md b/docs/sdks/suppliers/README.md index a99c378..b38b7f3 100644 --- a/docs/sdks/suppliers/README.md +++ b/docs/sdks/suppliers/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.suppliers.list(request={ +) as apideck: + res = apideck.accounting.suppliers.list(request={ "service_id": "salesforce", "filter_": { "company_name": "SpaceX", @@ -91,8 +91,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.suppliers.create(supplier={ +) as apideck: + res = apideck.accounting.suppliers.create(supplier={ "display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", @@ -298,8 +298,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.suppliers.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.suppliers.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -347,8 +347,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.suppliers.update(id="", supplier={ +) as apideck: + res = apideck.accounting.suppliers.update(id="", supplier={ "display_id": "EMP00101", "display_name": "Windsurf Shop", "company_name": "SpaceX", @@ -604,8 +604,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.suppliers.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.suppliers.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/taxrates/README.md b/docs/sdks/taxrates/README.md index 3a0ce85..021efc3 100644 --- a/docs/sdks/taxrates/README.md +++ b/docs/sdks/taxrates/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.list(request={ +) as apideck: + res = apideck.accounting.tax_rates.list(request={ "service_id": "salesforce", "filter_": { "assets": True, @@ -85,8 +85,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.create(tax_rate={ +) as apideck: + res = apideck.accounting.tax_rates.create(tax_rate={ "id": "1234", "name": "GST on Purchases", "code": "ABN", @@ -183,8 +183,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.tax_rates.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -232,8 +232,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.update(id="", tax_rate={ +) as apideck: + res = apideck.accounting.tax_rates.update(id="", tax_rate={ "id": "1234", "name": "GST on Purchases", "code": "ABN", @@ -358,8 +358,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tax_rates.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.tax_rates.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/timeoffrequests/README.md b/docs/sdks/timeoffrequests/README.md index e44e03d..a2b01c6 100644 --- a/docs/sdks/timeoffrequests/README.md +++ b/docs/sdks/timeoffrequests/README.md @@ -26,8 +26,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.time_off_requests.list(request={ +) as apideck: + res = apideck.hris.time_off_requests.list(request={ "service_id": "salesforce", "filter_": { "start_date": "2022-04-08", @@ -86,8 +86,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.time_off_requests.create(time_off_request={ +) as apideck: + res = apideck.hris.time_off_requests.create(time_off_request={ "employee_id": "12345", "policy_id": "12345", "status": apideck_unify.TimeOffRequestStatusStatus.APPROVED, @@ -174,8 +174,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.time_off_requests.get(request={ +) as apideck: + res = apideck.hris.time_off_requests.get(request={ "id": "", "employee_id": "", "service_id": "salesforce", @@ -225,8 +225,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.time_off_requests.update(request={ +) as apideck: + res = apideck.hris.time_off_requests.update(request={ "id": "", "employee_id": "", "time_off_request": { @@ -358,8 +358,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.hris.time_off_requests.delete(id="", employee_id="", service_id="salesforce") +) as apideck: + res = apideck.hris.time_off_requests.delete(id="", employee_id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/trackingcategories/README.md b/docs/sdks/trackingcategories/README.md index 09266e8..64e7209 100644 --- a/docs/sdks/trackingcategories/README.md +++ b/docs/sdks/trackingcategories/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tracking_categories.list(request={ +) as apideck: + res = apideck.accounting.tracking_categories.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -77,8 +77,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tracking_categories.create(tracking_category={ +) as apideck: + res = apideck.accounting.tracking_categories.create(tracking_category={ "parent_id": "12345", "name": "Department", "code": "100", @@ -153,8 +153,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tracking_categories.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.accounting.tracking_categories.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -202,8 +202,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tracking_categories.update(id="", tracking_category={ +) as apideck: + res = apideck.accounting.tracking_categories.update(id="", tracking_category={ "parent_id": "12345", "name": "Department", "code": "100", @@ -321,8 +321,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.accounting.tracking_categories.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.accounting.tracking_categories.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/uploadsessions/README.md b/docs/sdks/uploadsessions/README.md index c63ae5e..31a35d4 100644 --- a/docs/sdks/uploadsessions/README.md +++ b/docs/sdks/uploadsessions/README.md @@ -24,8 +24,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.upload_sessions.create(create_upload_session_request={ +) as apideck: + res = apideck.file_storage.upload_sessions.create(create_upload_session_request={ "name": "Documents", "parent_folder_id": "1234", "size": 1810673, @@ -100,8 +100,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.upload_sessions.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.file_storage.upload_sessions.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -149,8 +149,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.upload_sessions.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.file_storage.upload_sessions.delete(id="", service_id="salesforce") if res is not None: # handle response @@ -196,8 +196,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.file_storage.upload_sessions.finish(request={ +) as apideck: + res = apideck.file_storage.upload_sessions.finish(request={ "id": "", "service_id": "salesforce", "digest": "sha=fpRyg5eVQletdZqEKaFlqwBXJzM=", diff --git a/docs/sdks/users/README.md b/docs/sdks/users/README.md index 2613b35..c8988ff 100644 --- a/docs/sdks/users/README.md +++ b/docs/sdks/users/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.users.list(request={ +) as apideck: + res = apideck.crm.users.list(request={ "service_id": "salesforce", "pass_through": { "search": "San Francisco", @@ -77,8 +77,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.users.create(user={ +) as apideck: + res = apideck.crm.users.create(user={ "emails": [ { "email": "elon@musk.com", @@ -206,8 +206,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.users.get(id="", service_id="salesforce", fields="id,updated_at") +) as apideck: + res = apideck.crm.users.get(id="", service_id="salesforce", fields="id,updated_at") if res is not None: # handle response @@ -255,8 +255,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.users.update(id="", user={ +) as apideck: + res = apideck.crm.users.update(id="", user={ "emails": [ { "email": "elon@musk.com", @@ -487,8 +487,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.crm.users.delete(id="", service_id="salesforce") +) as apideck: + res = apideck.crm.users.delete(id="", service_id="salesforce") if res is not None: # handle response diff --git a/docs/sdks/validateconnection/README.md b/docs/sdks/validateconnection/README.md index bc02279..fcc27cb 100644 --- a/docs/sdks/validateconnection/README.md +++ b/docs/sdks/validateconnection/README.md @@ -27,8 +27,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.vault.validate_connection.state(service_id="pipedrive", unified_api="crm") +) as apideck: + res = apideck.vault.validate_connection.state(service_id="pipedrive", unified_api="crm") if res is not None: # handle response diff --git a/docs/sdks/webhooks/README.md b/docs/sdks/webhooks/README.md index e6c0cdf..139a605 100644 --- a/docs/sdks/webhooks/README.md +++ b/docs/sdks/webhooks/README.md @@ -25,8 +25,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.webhook.webhooks.list() +) as apideck: + res = apideck.webhook.webhooks.list() if res is not None: # handle response @@ -72,8 +72,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.webhook.webhooks.create(request={ +) as apideck: + res = apideck.webhook.webhooks.create(request={ "unified_api": apideck_unify.UnifiedAPIID.CRM, "status": apideck_unify.Status.ENABLED, "delivery_url": "https://example.com/my/webhook/endpoint", @@ -126,8 +126,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.webhook.webhooks.get(id="") +) as apideck: + res = apideck.webhook.webhooks.get(id="") if res is not None: # handle response @@ -172,8 +172,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.webhook.webhooks.update(id="", update_webhook_request={ +) as apideck: + res = apideck.webhook.webhooks.update(id="", update_webhook_request={ "description": "A description", "status": apideck_unify.Status.ENABLED, "delivery_url": "https://example.com/my/webhook/endpoint", @@ -226,8 +226,8 @@ with Apideck( api_key=os.getenv("APIDECK_API_KEY", ""), consumer_id="test-consumer", app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", -) as s: - res = s.webhook.webhooks.delete(id="") +) as apideck: + res = apideck.webhook.webhooks.delete(id="") if res is not None: # handle response diff --git a/pyproject.toml b/pyproject.toml index 258874a..617150c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "apideck-unify" -version = "0.0.1" +version = "0.1.7" description = "Python Client SDK Generated by Speakeasy." authors = ["Speakeasy",] readme = "README-PYPI.md" @@ -18,9 +18,9 @@ in-project = true [tool.poetry.dependencies] python = "^3.8" eval-type-backport = "^0.2.0" -httpx = "^0.27.0" +httpx = "^0.28.1" jsonpath-python = "^1.0.6" -pydantic = "~2.9.2" +pydantic = "~2.10.3" python-dateutil = "^2.8.2" typing-inspect = "^0.9.0" diff --git a/src/apideck_unify/_version.py b/src/apideck_unify/_version.py index 92c7db6..7229bdc 100644 --- a/src/apideck_unify/_version.py +++ b/src/apideck_unify/_version.py @@ -3,7 +3,7 @@ import importlib.metadata __title__: str = "apideck-unify" -__version__: str = "0.0.1" +__version__: str = "0.1.7" try: if __package__ is not None: diff --git a/src/apideck_unify/attachments.py b/src/apideck_unify/attachments.py index 5386f1b..a7b6335 100644 --- a/src/apideck_unify/attachments.py +++ b/src/apideck_unify/attachments.py @@ -11,7 +11,7 @@ class DownloadAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" - WILDCARD_WILDCARD_ = "*/*" + WILDCARD_ROOT_WILDCARD_ = "*/*" class Attachments(BaseSDK): diff --git a/src/apideck_unify/basesdk.py b/src/apideck_unify/basesdk.py index 88fa82d..21b2b41 100644 --- a/src/apideck_unify/basesdk.py +++ b/src/apideck_unify/basesdk.py @@ -10,6 +10,7 @@ from apideck_unify.utils import RetryConfig, SerializedRequestBody, get_body_content import httpx from typing import Callable, List, Optional, Tuple +from urllib.parse import parse_qs, urlparse class BaseSDK: @@ -145,6 +146,12 @@ def build_request_with_client( request if request_has_query_params else None, _globals if request_has_query_params else None, ) + else: + # Pick up the query parameter from the override so they can be + # preserved when building the request later on (necessary as of + # httpx 0.28). + parsed_override = urlparse(str(url_override)) + query_params = parse_qs(parsed_override.query, keep_blank_values=True) headers = utils.get_headers(request, _globals) headers["Accept"] = accept_header_value diff --git a/src/apideck_unify/files.py b/src/apideck_unify/files.py index 811585a..1ce3fe2 100644 --- a/src/apideck_unify/files.py +++ b/src/apideck_unify/files.py @@ -11,12 +11,12 @@ class DownloadAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" - WILDCARD_WILDCARD_ = "*/*" + WILDCARD_ROOT_WILDCARD_ = "*/*" class ExportAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" - WILDCARD_WILDCARD_ = "*/*" + WILDCARD_ROOT_WILDCARD_ = "*/*" class Files(BaseSDK): @@ -1470,7 +1470,7 @@ def export( self, *, id: str, - format: str, + file_format: str, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1483,7 +1483,7 @@ def export( Export File :param id: ID of the record you are acting upon. - :param format: File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. + :param file_format: File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -1503,7 +1503,7 @@ def export( id=id, service_id=service_id, fields=fields, - format=format, + file_format=file_format, ) req = self.build_request( @@ -1602,7 +1602,7 @@ async def export_async( self, *, id: str, - format: str, + file_format: str, service_id: Optional[str] = None, fields: OptionalNullable[str] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, @@ -1615,7 +1615,7 @@ async def export_async( Export File :param id: ID of the record you are acting upon. - :param format: File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. + :param file_format: File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource. :param service_id: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. :param fields: The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. :param retries: Override the default retry configuration for this method @@ -1635,7 +1635,7 @@ async def export_async( id=id, service_id=service_id, fields=fields, - format=format, + file_format=file_format, ) req = self.build_request_async( diff --git a/src/apideck_unify/models/connectordoc.py b/src/apideck_unify/models/connectordoc.py index 55ab293..9dc76cd 100644 --- a/src/apideck_unify/models/connectordoc.py +++ b/src/apideck_unify/models/connectordoc.py @@ -3,8 +3,9 @@ from __future__ import annotations from apideck_unify.types import BaseModel from enum import Enum +import pydantic from typing import Optional -from typing_extensions import NotRequired, TypedDict +from typing_extensions import Annotated, NotRequired, TypedDict class Audience(str, Enum): @@ -27,7 +28,7 @@ class ConnectorDocTypedDict(TypedDict): r"""Name of the doc.""" audience: NotRequired[Audience] r"""Audience for the doc.""" - format: NotRequired[Format] + format_: NotRequired[Format] r"""Format of the doc.""" url: NotRequired[str] r"""Link to fetch the content of the doc.""" @@ -43,7 +44,7 @@ class ConnectorDoc(BaseModel): audience: Optional[Audience] = None r"""Audience for the doc.""" - format: Optional[Format] = None + format_: Annotated[Optional[Format], pydantic.Field(alias="format")] = None r"""Format of the doc.""" url: Optional[str] = None diff --git a/src/apideck_unify/models/filestorage_filesexportop.py b/src/apideck_unify/models/filestorage_filesexportop.py index 006c829..54c2de5 100644 --- a/src/apideck_unify/models/filestorage_filesexportop.py +++ b/src/apideck_unify/models/filestorage_filesexportop.py @@ -51,7 +51,7 @@ class FileStorageFilesExportGlobals(BaseModel): class FileStorageFilesExportRequestTypedDict(TypedDict): id: str r"""ID of the record you are acting upon.""" - format: str + file_format: str r"""File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource.""" service_id: NotRequired[str] r"""Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.""" @@ -65,7 +65,7 @@ class FileStorageFilesExportRequest(BaseModel): ] r"""ID of the record you are acting upon.""" - format: Annotated[ + file_format: Annotated[ str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True)) ] r"""File format to export this file to. A list of available file formats for the current file is available as `export_formats` on the File resource.""" diff --git a/src/apideck_unify/sdkconfiguration.py b/src/apideck_unify/sdkconfiguration.py index cd3ca4e..7d349c4 100644 --- a/src/apideck_unify/sdkconfiguration.py +++ b/src/apideck_unify/sdkconfiguration.py @@ -28,9 +28,9 @@ class SDKConfiguration: server_idx: Optional[int] = 0 language: str = "python" openapi_doc_version: str = "10.8.3" - sdk_version: str = "0.0.1" - gen_version: str = "2.472.1" - user_agent: str = "speakeasy-sdk/python 0.0.1 2.472.1 10.8.3 apideck-unify" + sdk_version: str = "0.1.7" + gen_version: str = "2.474.15" + user_agent: str = "speakeasy-sdk/python 0.1.7 2.474.15 10.8.3 apideck-unify" retry_config: OptionalNullable[RetryConfig] = Field(default_factory=lambda: UNSET) timeout_ms: Optional[int] = None