@zuora-sdk/javascript-sdk NPM

@zuora-sdk/javascript-sdk

@ZuoraSdkJavascriptSdk - JavaScript client for @zuora-sdk/javascript-sdk No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

API version: 2022-11-09
Package version: 2.1.5
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @zuora-sdk/javascript-sdk --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @zuora-sdk/javascript-sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var @ZuoraSdkJavascriptSdk = require('@zuora-sdk/javascript-sdk');


var api = new @ZuoraSdkJavascriptSdk.AccountsApi()
var account_create_request = {"name":"Amy Lawrence Account","currency":"USD","bill_to":{"first_name":"Amy","last_name":"Lawrence","address":{"line1":"101 Redwood Shores Parkway","line2":"Suite 1150","city":"Redwood City","state":"California","country":"USA","postal_code":"94065"},"work_phone":"(888) 976-9056","work_email":"amy.lawrence@gmail.com"},"sold_to":{"first_name":"Amy","last_name":"Lawrence","address":{"line1":"101 Redwood Shores Parkway","line2":"","city":"Redwood City","state":"California","country":"USA","postal_code":"94065"},"work_phone":"(888) 976-9056","work_email":"amy.lawrence@gmail.com"},"custom_fields":{"field__c":"custom field value"},"payment_terms":"Due Upon Receipt","tax_certificate":{"start_date":"2022-01-01","end_date":"2023-01-01","state":"pending"},"sequence_set_id":"8f64d4d793733fb0be444ff770a932c7","billing_document_settings":{"additional_email":["jane.doe@gmail.com","james.lawerence@gmail.com"],"email_documents":true}}; // {AccountCreateRequest} 
var opts = {
  'zuora_track_id': "zuora_track_id_example", // {String} A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').
  'async': true, // {Boolean} Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.
  'zuora_entity_id': "zuora_entity_id_example", // {String} An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.
  'idempotency_key': "idempotency_key_example", // {String} Specify a unique idempotency key if you want to perform an idempotent `POST` or `PATCH` request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://www.zuora.com/developer/v2-api-reference/#tag/Idempotent-Requests).
  'accept_encoding': "accept_encoding_example", // {String} Include a `Accept-Encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://www.zuora.com/developer/v2-api-reference/#tag/Request-and-Response-Compression).
  'content_encoding': "content_encoding_example" // {String} Include a `Content-Encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://www.zuora.com/developer/v2-api-reference/#tag/Request-and-Response-Compression).
};
api.createAccount(account_create_request, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://rest.sandbox.na.zuora.com/v2

Class	Method	HTTP request	Description
@ZuoraSdkJavascriptSdk.AccountsApi	createAccount	POST /accounts	Create an account
@ZuoraSdkJavascriptSdk.AccountsApi	deleteAccount	DELETE /accounts/{account_id}	Delete an account
@ZuoraSdkJavascriptSdk.AccountsApi	getAccount	GET /accounts/{account_id}	Retrieve an account
@ZuoraSdkJavascriptSdk.AccountsApi	getAccounts	GET /accounts	List all accounts
@ZuoraSdkJavascriptSdk.AccountsApi	updateAccount	PATCH /accounts/{account_id}	Update an account
@ZuoraSdkJavascriptSdk.BillingDocumentItemsApi	getBillingDocumentItems	GET /billing_document_items	List billing document items
@ZuoraSdkJavascriptSdk.BillingDocumentsApi	getBillingDocument	GET /billing_documents/{billing_document_id}	Retrieve a billing document
@ZuoraSdkJavascriptSdk.BillingDocumentsApi	getBillingDocuments	GET /billing_documents	List all billing documents
@ZuoraSdkJavascriptSdk.BillingDocumentsApi	postBillingDocument	POST /billing_documents	Create a billing document
@ZuoraSdkJavascriptSdk.ContactsApi	createContact	POST /contacts	Create a contact
@ZuoraSdkJavascriptSdk.ContactsApi	deleteContact	DELETE /contacts/{contact_id}	Delete a contact
@ZuoraSdkJavascriptSdk.ContactsApi	getContact	GET /contacts/{contact_id}	Retrieve a contact
@ZuoraSdkJavascriptSdk.ContactsApi	getContacts	GET /contacts	List all contacts
@ZuoraSdkJavascriptSdk.ContactsApi	updateContact	PATCH /contacts/{contact_id}	Update a contact
@ZuoraSdkJavascriptSdk.CustomObjectsApi	createCustomObject	POST /custom_objects/{custom_object_type}	Create a custom object
@ZuoraSdkJavascriptSdk.CustomObjectsApi	deleteCustomObject	DELETE /custom_objects/{custom_object_type}/{custom_object_id}	Delete a custom object
@ZuoraSdkJavascriptSdk.CustomObjectsApi	getCustomObject	GET /custom_objects/{custom_object_type}/{custom_object_id}	Retrieve a custom object
@ZuoraSdkJavascriptSdk.CustomObjectsApi	getCustomObjects	GET /custom_objects/{custom_object_type}	List custom objects
@ZuoraSdkJavascriptSdk.CustomObjectsApi	updateCustomObject	PATCH /custom_objects/{custom_object_type}/{custom_object_id}	Update a custom object
@ZuoraSdkJavascriptSdk.PaymentMethodsApi	createPaymentMethod	POST /payment_methods	Create a payment method
@ZuoraSdkJavascriptSdk.PaymentMethodsApi	deletePaymentMethod	DELETE /payment_methods/{payment_method_id}	Delete a payment method
@ZuoraSdkJavascriptSdk.PaymentMethodsApi	getPaymentMethodById	GET /payment_methods/{payment_method_id}	Retrieve a payment method
@ZuoraSdkJavascriptSdk.PaymentMethodsApi	getPaymentMethods	GET /payment_methods	List all payment methods
@ZuoraSdkJavascriptSdk.PaymentMethodsApi	updatePaymentMethod	PATCH /payment_methods/{payment_method_id}	Update a payment method
@ZuoraSdkJavascriptSdk.PaymentsApi	applyPayment	PUT /payments/{payment_id}/apply	Apply a payment
@ZuoraSdkJavascriptSdk.PaymentsApi	cancelPayment	POST /payments/{payment_id}/cancel	Cancel a payment
@ZuoraSdkJavascriptSdk.PaymentsApi	createPayment	POST /payments	Create a payment
@ZuoraSdkJavascriptSdk.PaymentsApi	getPayment	GET /payments/{payment_id}	Retrieve a payment
@ZuoraSdkJavascriptSdk.PaymentsApi	getPayments	GET /payments	List all payments
@ZuoraSdkJavascriptSdk.PaymentsApi	unapplyPayment	PUT /payments/{payment_id}/unapply	Unapply a payment
@ZuoraSdkJavascriptSdk.PaymentsApi	updatePayment	PATCH /payments/{payment_id}	Update a payment
@ZuoraSdkJavascriptSdk.PlansApi	createPlan	POST /plans	Create a plan
@ZuoraSdkJavascriptSdk.PlansApi	deletePlan	DELETE /plans/{plan_id}	Delete a plan
@ZuoraSdkJavascriptSdk.PlansApi	getPlan	GET /plans/{plan_id}	Retrieve a plan
@ZuoraSdkJavascriptSdk.PlansApi	getPlans	GET /plans	List all plans
@ZuoraSdkJavascriptSdk.PlansApi	updatePlan	PATCH /plans/{plan_id}	Update a plan
@ZuoraSdkJavascriptSdk.PricesApi	createPrice	POST /prices	Create a price
@ZuoraSdkJavascriptSdk.PricesApi	deletePrice	DELETE /prices/{price_id}	Delete a price
@ZuoraSdkJavascriptSdk.PricesApi	getPrice	GET /prices/{price_id}	Retrieve a price
@ZuoraSdkJavascriptSdk.PricesApi	getPrices	GET /prices	List all prices
@ZuoraSdkJavascriptSdk.PricesApi	patchPrice	PATCH /prices/{price_id}	Update a price
@ZuoraSdkJavascriptSdk.ProductsApi	createProduct	POST /products	Create a product
@ZuoraSdkJavascriptSdk.ProductsApi	deleteProduct	DELETE /products/{product_id}	Delete a product
@ZuoraSdkJavascriptSdk.ProductsApi	getProduct	GET /products/{product_id}	Retrieve a product
@ZuoraSdkJavascriptSdk.ProductsApi	getProducts	GET /products	List all products
@ZuoraSdkJavascriptSdk.ProductsApi	updateProduct	PATCH /products/{product_id}	Update a product
@ZuoraSdkJavascriptSdk.RefundsApi	createRefund	POST /refunds	Create a refund
@ZuoraSdkJavascriptSdk.RefundsApi	getRefund	GET /refunds/{refund_id}	Retrieve a refund
@ZuoraSdkJavascriptSdk.RefundsApi	getRefunds	GET /refunds	List all refunds
@ZuoraSdkJavascriptSdk.RefundsApi	updateRefund	PATCH /refunds/{refund_id}	Update a refund
@ZuoraSdkJavascriptSdk.SubscriptionItemsApi	getSubscriptionItems	GET /subscription_items	List all subscription items
@ZuoraSdkJavascriptSdk.SubscriptionPlansApi	getSubscriptionPlan	GET /subscription_plans/{subscription_plan_id}	Retrieve a subscription plan
@ZuoraSdkJavascriptSdk.SubscriptionPlansApi	getSubscriptionPlans	GET /subscription_plans	List all subscription plans
@ZuoraSdkJavascriptSdk.SubscriptionsApi	activateSubscription	POST /subscriptions/{subscription_id}/activate	Activate a subscription
@ZuoraSdkJavascriptSdk.SubscriptionsApi	cancelSubscription	POST /subscriptions/{subscription_id}/cancel	Cancel a subscription
@ZuoraSdkJavascriptSdk.SubscriptionsApi	createSubscription	POST /subscriptions	Create a subscription
@ZuoraSdkJavascriptSdk.SubscriptionsApi	getSubscriptionByKey	GET /subscriptions/{subscription_id}	Retrieve a subscription
@ZuoraSdkJavascriptSdk.SubscriptionsApi	getSubscriptions	GET /subscriptions	List all subscriptions
@ZuoraSdkJavascriptSdk.SubscriptionsApi	patchSubscription	PATCH /subscriptions/{subscription_id}	Update a subscription
@ZuoraSdkJavascriptSdk.SubscriptionsApi	pauseSubscription	POST /subscriptions/{subscription_id}/pause	Pause a subscription
@ZuoraSdkJavascriptSdk.SubscriptionsApi	previewSubscription	POST /subscriptions/preview	Preview a subscription
@ZuoraSdkJavascriptSdk.SubscriptionsApi	resumeSubscription	POST /subscriptions/{subscription_id}/resume	Resume a subscription
@ZuoraSdkJavascriptSdk.SubscriptionsApi	uncancelSubscription	POST /subscriptions/{subscription_id}/keep	Uncancel a subscription
@ZuoraSdkJavascriptSdk.WorkflowsApi	runWorkflow	POST /workflows/{workflow_id}/run	Run a workflow