@field123/service-subscriptions-sdk

v0.1.2-alpha.1

Published

10 months ago

<div align="left"> <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://opensource.

Downloads

0High
0Medium
0Low

field123

openapi

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

[ ] 🛠 Make your SDK feel handcrafted by customizing it
[ ] ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
[ ] 🎁 Publish your SDK to package managers by configuring automatic publishing
[ ] ✨ When ready to productionize, delete this section from the README

SDK Installation

NPM

npm add <UNSET>

Yarn

yarn add <UNSET>

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Subscriptions } from "@field123/service-subscriptions-sdk";
import {
    SubscriptionProductType,
    Unit,
} from "@field123/service-subscriptions-sdk/models/components";

async function run() {
    const sdk = new Subscriptions({
        bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const result = await sdk.products.createProduct({
        filter: "eq(name,Alan Turing)",
        requestBody: {
            data: {
                type: SubscriptionProductType.SubscriptionProduct,
                attributes: {
                    externalRef: "abc123",
                    name: "Magazine",
                    description: "A lovely magazine that is published every month.",
                    sku: "MAGAZINE1",
                    mainImage: "https://magazine.com/cover.jpg",
                    price: {
                        USD: {
                            amount: 100,
                            includesTax: false,
                        },
                        GBP: {
                            amount: 90,
                            includesTax: true,
                        },
                    },
                    priceUnits: {
                        unit: Unit.Day,
                        amount: 7,
                    },
                },
            },
        },
    });

    // Handle the result
    console.log(result);
}

run();

Available Resources and Operations

products

createProduct - Create a product
listProducts - List products
getProduct - Get product
deleteProduct - Delete product
updateProduct - Update a product

plans

createPlan - Create a plan
listPlans - List plans
getPlan - Get plan
deletePlan - Delete plan
updatePlan - Update a plan

offerings

createOffering - Create an offering
listOfferings - List offerings
buildOffering - Build an offering
getOffering - Get offering
deleteOffering - Delete offering
updateOffering - Update an offering
listOfferingPlans - List an offering's plans
attachOfferingPlan - Attach a plan
updateOfferingPlan - Updates a plan in an offering
deleteOfferingPlan - Remove a plan from an offering
listOfferingProducts - List an offering's products
attachOfferingProduct - Attach a product
updateOfferingProduct - Updates a product in an offering
deleteOfferingProduct - Remove a product from an offering

subscriptions

createSubscription - Create a subscription
listSubscriptions - List subscriptions
getSubscription - Get subscription
deleteSubscription - Delete subscription
listSubscriptionInvoices - List subscription invoices
cancelSubscription - Cancels subscription
listSubscriptionInvoicePayments - List subscription invoice payments
getSubscriptionInvoicePayment - Get subscription invoice payment
getSubscriptionInvoice - Get subscription invoice

jobs

createJob - Create a job
listJobs - List jobs
getJob - Get job
deleteJob - Delete job

schedules

listSchedules - List schedules
createSchedule - Create a schedule
getSchedule - Get a schedule
updateSchedule - Update a schedule
deleteSchedule - Delete schedule

subscribers

listSubscribers - List subscribers
createSubscriber - Create a subscriber
getSubscriber - Get a subscriber
updateSubscriber - Update a subscriber
deleteSubscriber - Delete subscriber

Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

| Error Object | Status Code | Content Type | | -------------------- | -------------------- | -------------------- | | errors.ErrorResponse | 400,500 | application/json | | errors.SDKError | 4xx-5xx | / |

Example

import { Subscriptions } from "@field123/service-subscriptions-sdk";
import {
    SubscriptionProductType,
    Unit,
} from "@field123/service-subscriptions-sdk/models/components";

async function run() {
    const sdk = new Subscriptions({
        bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
    });

    let result;
    try {
        result = await sdk.products.createProduct({
            filter: "eq(name,Alan Turing)",
            requestBody: {
                data: {
                    type: SubscriptionProductType.SubscriptionProduct,
                    attributes: {
                        externalRef: "abc123",
                        name: "Magazine",
                        description: "A lovely magazine that is published every month.",
                        sku: "MAGAZINE1",
                        mainImage: "https://magazine.com/cover.jpg",
                        price: {
                            USD: {
                                amount: 100,
                                includesTax: false,
                            },
                            GBP: {
                                amount: 90,
                                includesTax: true,
                            },
                        },
                        priceUnits: {
                            unit: Unit.Day,
                            amount: 7,
                        },
                    },
                },
            },
        });
    } catch (err) {
        switch (true) {
            case err instanceof errors.ErrorResponse: {
                console.error(err); // handle exception
                return;
            }
            default: {
                throw err;
            }
        }
    }

    // Handle the result
    console.log(result);
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Variables | | - | ------ | --------- | | 0 | https://epcc-integration.global.ssl.fastly.net/v2 | None | | 1 | https://api.epcc-staging.epcloudops.com/v2 | None | | 2 | https://api.moltin.com/v2 | None | | 3 | https://useast.api.elasticpath.com/v2 | None |

import { Subscriptions } from "@field123/service-subscriptions-sdk";
import {
    SubscriptionProductType,
    Unit,
} from "@field123/service-subscriptions-sdk/models/components";

async function run() {
    const sdk = new Subscriptions({
        serverIdx: 3,
        bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const result = await sdk.products.createProduct({
        filter: "eq(name,Alan Turing)",
        requestBody: {
            data: {
                type: SubscriptionProductType.SubscriptionProduct,
                attributes: {
                    externalRef: "abc123",
                    name: "Magazine",
                    description: "A lovely magazine that is published every month.",
                    sku: "MAGAZINE1",
                    mainImage: "https://magazine.com/cover.jpg",
                    price: {
                        USD: {
                            amount: 100,
                            includesTax: false,
                        },
                        GBP: {
                            amount: 90,
                            includesTax: true,
                        },
                    },
                    priceUnits: {
                        unit: Unit.Day,
                        amount: 7,
                    },
                },
            },
        },
    });

    // Handle the result
    console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:

import { Subscriptions } from "@field123/service-subscriptions-sdk";
import {
    SubscriptionProductType,
    Unit,
} from "@field123/service-subscriptions-sdk/models/components";

async function run() {
    const sdk = new Subscriptions({
        serverURL: "https://epcc-integration.global.ssl.fastly.net/v2",
        bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const result = await sdk.products.createProduct({
        filter: "eq(name,Alan Turing)",
        requestBody: {
            data: {
                type: SubscriptionProductType.SubscriptionProduct,
                attributes: {
                    externalRef: "abc123",
                    name: "Magazine",
                    description: "A lovely magazine that is published every month.",
                    sku: "MAGAZINE1",
                    mainImage: "https://magazine.com/cover.jpg",
                    price: {
                        USD: {
                            amount: 100,
                            includesTax: false,
                        },
                        GBP: {
                            amount: 90,
                            includesTax: true,
                        },
                    },
                    priceUnits: {
                        unit: Unit.Day,
                        amount: 7,
                    },
                },
            },
        },
    });

    // Handle the result
    console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Subscriptions } from "@field123/service-subscriptions-sdk";
import { HTTPClient } from "@field123/service-subscriptions-sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000);
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Subscriptions({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------- | ------------- | ------------- | | bearerToken | http | HTTP Bearer |

To authenticate with the API the bearerToken parameter must be set when initializing the SDK client instance. For example:

import { Subscriptions } from "@field123/service-subscriptions-sdk";
import {
    SubscriptionProductType,
    Unit,
} from "@field123/service-subscriptions-sdk/models/components";

async function run() {
    const sdk = new Subscriptions({
        bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const result = await sdk.products.createProduct({
        filter: "eq(name,Alan Turing)",
        requestBody: {
            data: {
                type: SubscriptionProductType.SubscriptionProduct,
                attributes: {
                    externalRef: "abc123",
                    name: "Magazine",
                    description: "A lovely magazine that is published every month.",
                    sku: "MAGAZINE1",
                    mainImage: "https://magazine.com/cover.jpg",
                    price: {
                        USD: {
                            amount: 100,
                            includesTax: false,
                        },
                        GBP: {
                            amount: 90,
                            includesTax: true,
                        },
                    },
                    priceUnits: {
                        unit: Unit.Day,
                        amount: 7,
                    },
                },
            },
        },
    });

    // Handle the result
    console.log(result);
}

run();

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

openapi

🏗 Welcome to your new SDK! 🏗

SDK Installation

NPM

Yarn

Requirements

SDK Example Usage

Example

Available Resources and Operations

products

plans

offerings

subscriptions

jobs

schedules

subscribers

Error Handling

Server Selection

Select Server by Index

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Development

Maturity

Contributions

SDK Created by Speakeasy