@openroam/sdk 0.1.0-rc.4 → 0.1.0-rc.6

package/dist/esm/models/EsimDailyUsageEntry.js

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenRoam Partner API
+ * Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: support@openroam.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the EsimDailyUsageEntry interface.
+ */
+export function instanceOfEsimDailyUsageEntry(value) {
+    return true;
+}
+export function EsimDailyUsageEntryFromJSON(json) {
+    return EsimDailyUsageEntryFromJSONTyped(json, false);
+}
+export function EsimDailyUsageEntryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'date': json['date'] == null ? undefined : json['date'],
+        'usage': json['usage'] == null ? undefined : json['usage'],
+        'location': json['location'] == null ? undefined : json['location'],
+    };
+}
+export function EsimDailyUsageEntryToJSON(json) {
+    return EsimDailyUsageEntryToJSONTyped(json, false);
+}
+export function EsimDailyUsageEntryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'date': value['date'],
+        'usage': value['usage'],
+        'location': value['location'],
+    };
+}

package/dist/esm/models/EsimDataAllowance.d.ts

@@ -0,0 +1,38 @@
+/**
+ * OpenRoam Partner API
+ * Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: support@openroam.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The plan's data allowance as the catalogue stores it: amount, unit and display label.
+ * @export
+ * @interface EsimDataAllowance
+ */
+export interface EsimDataAllowance {
+    /**
+     *
+     */
+    amount?: number;
+    /**
+     *
+     */
+    unit?: string | null;
+    /**
+     *
+     */
+    label?: string;
+}
+/**
+ * Check if a given object implements the EsimDataAllowance interface.
+ */
+export declare function instanceOfEsimDataAllowance(value: object): value is EsimDataAllowance;
+export declare function EsimDataAllowanceFromJSON(json: any): EsimDataAllowance;
+export declare function EsimDataAllowanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): EsimDataAllowance;
+export declare function EsimDataAllowanceToJSON(json: any): EsimDataAllowance;
+export declare function EsimDataAllowanceToJSONTyped(value?: EsimDataAllowance | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EsimDataAllowance.js

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenRoam Partner API
+ * Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: support@openroam.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the EsimDataAllowance interface.
+ */
+export function instanceOfEsimDataAllowance(value) {
+    return true;
+}
+export function EsimDataAllowanceFromJSON(json) {
+    return EsimDataAllowanceFromJSONTyped(json, false);
+}
+export function EsimDataAllowanceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'amount': json['amount'] == null ? undefined : json['amount'],
+        'unit': json['unit'] === undefined ? undefined : json['unit'] === null ? null : json['unit'],
+        'label': json['label'] == null ? undefined : json['label'],
+    };
+}
+export function EsimDataAllowanceToJSON(json) {
+    return EsimDataAllowanceToJSONTyped(json, false);
+}
+export function EsimDataAllowanceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'amount': value['amount'],
+        'unit': value['unit'],
+        'label': value['label'],
+    };
+}

package/dist/esm/models/EsimDestinationList.d.ts

@@ -0,0 +1,31 @@
+/**
+ * OpenRoam Partner API
+ * Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: support@openroam.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { EsimDestinationSummary } from './EsimDestinationSummary';
+/**
+ * Every destination with an orderable offer, ordered by name. The list is small, so it is not paged.
+ * @export
+ * @interface EsimDestinationList
+ */
+export interface EsimDestinationList {
+    /**
+     *
+     */
+    items?: Array<EsimDestinationSummary>;
+}
+/**
+ * Check if a given object implements the EsimDestinationList interface.
+ */
+export declare function instanceOfEsimDestinationList(value: object): value is EsimDestinationList;
+export declare function EsimDestinationListFromJSON(json: any): EsimDestinationList;
+export declare function EsimDestinationListFromJSONTyped(json: any, ignoreDiscriminator: boolean): EsimDestinationList;
+export declare function EsimDestinationListToJSON(json: any): EsimDestinationList;
+export declare function EsimDestinationListToJSONTyped(value?: EsimDestinationList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EsimDestinationList.js

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenRoam Partner API
+ * Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: support@openroam.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EsimDestinationSummaryFromJSON, EsimDestinationSummaryToJSON, } from './EsimDestinationSummary';
+/**
+ * Check if a given object implements the EsimDestinationList interface.
+ */
+export function instanceOfEsimDestinationList(value) {
+    return true;
+}
+export function EsimDestinationListFromJSON(json) {
+    return EsimDestinationListFromJSONTyped(json, false);
+}
+export function EsimDestinationListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': json['items'] == null ? undefined : (json['items'].map(EsimDestinationSummaryFromJSON)),
+    };
+}
+export function EsimDestinationListToJSON(json) {
+    return EsimDestinationListToJSONTyped(json, false);
+}
+export function EsimDestinationListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': value['items'] == null ? undefined : (value['items'].map(EsimDestinationSummaryToJSON)),
+    };
+}

package/dist/esm/models/EsimFeatures.d.ts

@@ -0,0 +1,66 @@
+/**
+ * OpenRoam Partner API
+ * Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: support@openroam.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface EsimFeatures
+ */
+export interface EsimFeatures {
+    /**
+     *
+     */
+    withKyc?: boolean;
+    /**
+     *
+     */
+    withTopUp?: boolean;
+    /**
+     *
+     */
+    withHotspot?: boolean;
+    /**
+     *
+     */
+    withDataRoaming?: boolean;
+    /**
+     *
+     */
+    withSubscription?: boolean;
+    /**
+     *
+     */
+    withDestinationInstall?: boolean;
+    /**
+     *
+     */
+    withUsageCheck?: boolean;
+    /**
+     *
+     */
+    technology?: string;
+    /**
+     *
+     */
+    activation?: string;
+    /**
+     *
+     */
+    charge?: string;
+}
+/**
+ * Check if a given object implements the EsimFeatures interface.
+ */
+export declare function instanceOfEsimFeatures(value: object): value is EsimFeatures;
+export declare function EsimFeaturesFromJSON(json: any): EsimFeatures;
+export declare function EsimFeaturesFromJSONTyped(json: any, ignoreDiscriminator: boolean): EsimFeatures;
+export declare function EsimFeaturesToJSON(json: any): EsimFeatures;
+export declare function EsimFeaturesToJSONTyped(value?: EsimFeatures | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EsimFeatures.js

@@ -0,0 +1,59 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenRoam Partner API
+ * Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: support@openroam.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the EsimFeatures interface.
+ */
+export function instanceOfEsimFeatures(value) {
+    return true;
+}
+export function EsimFeaturesFromJSON(json) {
+    return EsimFeaturesFromJSONTyped(json, false);
+}
+export function EsimFeaturesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'withKyc': json['withKyc'] == null ? undefined : json['withKyc'],
+        'withTopUp': json['withTopUp'] == null ? undefined : json['withTopUp'],
+        'withHotspot': json['withHotspot'] == null ? undefined : json['withHotspot'],
+        'withDataRoaming': json['withDataRoaming'] == null ? undefined : json['withDataRoaming'],
+        'withSubscription': json['withSubscription'] == null ? undefined : json['withSubscription'],
+        'withDestinationInstall': json['withDestinationInstall'] == null ? undefined : json['withDestinationInstall'],
+        'withUsageCheck': json['withUsageCheck'] == null ? undefined : json['withUsageCheck'],
+        'technology': json['technology'] == null ? undefined : json['technology'],
+        'activation': json['activation'] == null ? undefined : json['activation'],
+        'charge': json['charge'] == null ? undefined : json['charge'],
+    };
+}
+export function EsimFeaturesToJSON(json) {
+    return EsimFeaturesToJSONTyped(json, false);
+}
+export function EsimFeaturesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'withKyc': value['withKyc'],
+        'withTopUp': value['withTopUp'],
+        'withHotspot': value['withHotspot'],
+        'withDataRoaming': value['withDataRoaming'],
+        'withSubscription': value['withSubscription'],
+        'withDestinationInstall': value['withDestinationInstall'],
+        'withUsageCheck': value['withUsageCheck'],
+        'technology': value['technology'],
+        'activation': value['activation'],
+        'charge': value['charge'],
+    };
+}

package/dist/esm/models/EsimFulfillment.d.ts

@@ -0,0 +1,55 @@
+/**
+ * OpenRoam Partner API
+ * Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: support@openroam.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { FulfillmentProgress } from './FulfillmentProgress';
+import type { EsimFulfillmentResult } from './EsimFulfillmentResult';
+import type { FulfillmentFailure } from './FulfillmentFailure';
+/**
+ *
+ * @export
+ * @interface EsimFulfillment
+ */
+export interface EsimFulfillment {
+    /**
+     * `pending`, `fulfilled` or `rejected`.
+     */
+    status?: EsimFulfillmentStatusEnum;
+    /**
+     *
+     */
+    result?: EsimFulfillmentResult | null;
+    /**
+     * Why delivery was rejected (`11001`, `FULFILLMENT_REJECTED`); set only when
+     *             `rejected`.
+     */
+    failure?: FulfillmentFailure | null;
+    /**
+     *
+     */
+    progress?: FulfillmentProgress | null;
+}
+/**
+ * @export
+ */
+export declare const EsimFulfillmentStatusEnum: {
+    readonly Pending: "pending";
+    readonly Fulfilled: "fulfilled";
+    readonly Rejected: "rejected";
+};
+export type EsimFulfillmentStatusEnum = typeof EsimFulfillmentStatusEnum[keyof typeof EsimFulfillmentStatusEnum];
+/**
+ * Check if a given object implements the EsimFulfillment interface.
+ */
+export declare function instanceOfEsimFulfillment(value: object): value is EsimFulfillment;
+export declare function EsimFulfillmentFromJSON(json: any): EsimFulfillment;
+export declare function EsimFulfillmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): EsimFulfillment;
+export declare function EsimFulfillmentToJSON(json: any): EsimFulfillment;
+export declare function EsimFulfillmentToJSONTyped(value?: EsimFulfillment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EsimFulfillment.js

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenRoam Partner API
+ * Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: support@openroam.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FulfillmentProgressFromJSON, FulfillmentProgressToJSON, } from './FulfillmentProgress';
+import { EsimFulfillmentResultFromJSON, EsimFulfillmentResultToJSON, } from './EsimFulfillmentResult';
+import { FulfillmentFailureFromJSON, FulfillmentFailureToJSON, } from './FulfillmentFailure';
+/**
+ * @export
+ */
+export const EsimFulfillmentStatusEnum = {
+    Pending: 'pending',
+    Fulfilled: 'fulfilled',
+    Rejected: 'rejected',
+};
+/**
+ * Check if a given object implements the EsimFulfillment interface.
+ */
+export function instanceOfEsimFulfillment(value) {
+    return true;
+}
+export function EsimFulfillmentFromJSON(json) {
+    return EsimFulfillmentFromJSONTyped(json, false);
+}
+export function EsimFulfillmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'] == null ? undefined : json['status'],
+        'result': json['result'] === undefined ? undefined : json['result'] === null ? null : EsimFulfillmentResultFromJSON(json['result']),
+        'failure': json['failure'] === undefined ? undefined : json['failure'] === null ? null : FulfillmentFailureFromJSON(json['failure']),
+        'progress': json['progress'] === undefined ? undefined : json['progress'] === null ? null : FulfillmentProgressFromJSON(json['progress']),
+    };
+}
+export function EsimFulfillmentToJSON(json) {
+    return EsimFulfillmentToJSONTyped(json, false);
+}
+export function EsimFulfillmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'result': EsimFulfillmentResultToJSON(value['result']),
+        'failure': FulfillmentFailureToJSON(value['failure']),
+        'progress': FulfillmentProgressToJSON(value['progress']),
+    };
+}

package/dist/esm/models/EsimFulfillmentDetails.d.ts

@@ -0,0 +1,142 @@
+/**
+ * OpenRoam Partner API
+ * Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: support@openroam.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { EsimAddon } from './EsimAddon';
+import type { EsimVoiceAllowance } from './EsimVoiceAllowance';
+import type { EsimInstallation } from './EsimInstallation';
+import type { EsimApn } from './EsimApn';
+import type { EsimProvisioning } from './EsimProvisioning';
+import type { EsimDataAllowance } from './EsimDataAllowance';
+import type { EsimSmsAllowance } from './EsimSmsAllowance';
+/**
+ * The eSIM an order item delivered: its ICCID and states, how to install it, and its plan. A top-up item reads the
+ * eSIM it topped up, with `mode` `topUp`.
+ * @export
+ * @interface EsimFulfillmentDetails
+ */
+export interface EsimFulfillmentDetails {
+    /**
+     * The eSIM's ICCID, which the post-purchase routes take; null until the eSIM is provisioned.
+     */
+    iccid?: string | null;
+    /**
+     * How the item was fulfilled: a new instant or deferred eSIM, or a top-up.
+     */
+    mode?: EsimFulfillmentDetailsModeEnum;
+    /**
+     * Progress of provisioning the eSIM.
+     */
+    provisioning?: EsimProvisioning;
+    /**
+     * True while a deferred eSIM waits for `POST /esims/{id}/provisioning`.
+     */
+    canProvision?: boolean;
+    /**
+     * The eSIM's lifecycle status. An eSIM under review reads as pending.
+     */
+    esimStatus?: EsimFulfillmentDetailsEsimStatusEnum;
+    /**
+     * The installed profile's status, as last recorded.
+     */
+    profileStatus?: EsimFulfillmentDetailsProfileStatusEnum;
+    /**
+     * Null until the eSIM is provisioned.
+     */
+    installation?: EsimInstallation | null;
+    /**
+     *
+     */
+    pin?: string | null;
+    /**
+     *
+     */
+    puk?: string | null;
+    /**
+     * The number assigned to the eSIM, when the plan includes one.
+     */
+    phoneNumber?: string | null;
+    /**
+     * The plan's data allowance as the catalogue stores it: amount, unit and display label.
+     */
+    data?: EsimDataAllowance | null;
+    /**
+     * The plan's calling allowance; null when the plan includes no calls.
+     */
+    voice?: EsimVoiceAllowance | null;
+    /**
+     * The plan's SMS allowance; null when the plan includes no SMS.
+     */
+    sms?: EsimSmsAllowance | null;
+    /**
+     *
+     */
+    apn?: EsimApn | null;
+    /**
+     * The top-ups applied to the eSIM.
+     */
+    addons?: Array<EsimAddon>;
+    /**
+     * Stored notes about the plan, shown verbatim.
+     */
+    notes?: Array<string>;
+    /**
+     *
+     */
+    fulfilledAt?: Date | null;
+}
+/**
+ * @export
+ */
+export declare const EsimFulfillmentDetailsModeEnum: {
+    readonly Deferred: "deferred";
+    readonly Instant: "instant";
+    readonly TopUp: "topUp";
+};
+export type EsimFulfillmentDetailsModeEnum = typeof EsimFulfillmentDetailsModeEnum[keyof typeof EsimFulfillmentDetailsModeEnum];
+/**
+ * @export
+ */
+export declare const EsimFulfillmentDetailsEsimStatusEnum: {
+    readonly New: "new";
+    readonly Procuring: "procuring";
+    readonly Pending: "pending";
+    readonly Failed: "failed";
+    readonly Ready: "ready";
+    readonly Cancelled: "cancelled";
+    readonly Revoked: "revoked";
+    readonly Expired: "expired";
+    readonly Unknown: "unknown";
+};
+export type EsimFulfillmentDetailsEsimStatusEnum = typeof EsimFulfillmentDetailsEsimStatusEnum[keyof typeof EsimFulfillmentDetailsEsimStatusEnum];
+/**
+ * @export
+ */
+export declare const EsimFulfillmentDetailsProfileStatusEnum: {
+    readonly Empty: "empty";
+    readonly New: "new";
+    readonly Downloaded: "downloaded";
+    readonly Installed: "installed";
+    readonly Activated: "activated";
+    readonly Inactive: "inactive";
+    readonly Deleted: "deleted";
+    readonly Revoked: "revoked";
+    readonly Expired: "expired";
+    readonly Unknown: "unknown";
+};
+export type EsimFulfillmentDetailsProfileStatusEnum = typeof EsimFulfillmentDetailsProfileStatusEnum[keyof typeof EsimFulfillmentDetailsProfileStatusEnum];
+/**
+ * Check if a given object implements the EsimFulfillmentDetails interface.
+ */
+export declare function instanceOfEsimFulfillmentDetails(value: object): value is EsimFulfillmentDetails;
+export declare function EsimFulfillmentDetailsFromJSON(json: any): EsimFulfillmentDetails;
+export declare function EsimFulfillmentDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): EsimFulfillmentDetails;
+export declare function EsimFulfillmentDetailsToJSON(json: any): EsimFulfillmentDetails;
+export declare function EsimFulfillmentDetailsToJSONTyped(value?: EsimFulfillmentDetails | null, ignoreDiscriminator?: boolean): any;