@managespace/sdk 0.1.56 → 0.1.57

package/src/generated/models/apply-pending-changes.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ApplyPendingChanges
+ */
+export interface ApplyPendingChanges {
+    /**
+     * Array of pending change IDs to apply
+     * @type {Array<string>}
+     * @memberof ApplyPendingChanges
+     */
+    changeIds: Array<string>;
+}
+
+/**
+ * Check if a given object implements the ApplyPendingChanges interface.
+ */
+export function instanceOfApplyPendingChanges(value: object): value is ApplyPendingChanges {
+    if (!('changeIds' in value) || value['changeIds'] === undefined) return false;
+    return true;
+}
+
+export function ApplyPendingChangesFromJSON(json: any): ApplyPendingChanges {
+    return ApplyPendingChangesFromJSONTyped(json, false);
+}
+
+export function ApplyPendingChangesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApplyPendingChanges {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'changeIds': json['changeIds'],
+    };
+}
+
+export function ApplyPendingChangesToJSON(json: any): ApplyPendingChanges {
+    return ApplyPendingChangesToJSONTyped(json, false);
+}
+
+export function ApplyPendingChangesToJSONTyped(value?: ApplyPendingChanges | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'changeIds': value['changeIds'],
+    };
+}
+

package/src/generated/models/apply-rule-to-customer-dto.ts

@@ -0,0 +1,106 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { SubscriptionChargeSelectionDto } from './subscription-charge-selection-dto';
+import {
+    SubscriptionChargeSelectionDtoFromJSON,
+    SubscriptionChargeSelectionDtoFromJSONTyped,
+    SubscriptionChargeSelectionDtoToJSON,
+    SubscriptionChargeSelectionDtoToJSONTyped,
+} from './subscription-charge-selection-dto';
+
+/**
+ * 
+ * @export
+ * @interface ApplyRuleToCustomerDto
+ */
+export interface ApplyRuleToCustomerDto {
+    /**
+     * Customer ID to apply the rule to
+     * @type {string}
+     * @memberof ApplyRuleToCustomerDto
+     */
+    customerId: string;
+    /**
+     * Unit IDs to apply the rule to (optional, if not provided, applies to all units)
+     * @type {Array<string>}
+     * @memberof ApplyRuleToCustomerDto
+     */
+    unitIds?: Array<string>;
+    /**
+     * Charge IDs to apply the rule to (legacy - use subscriptionCharges for precision)
+     * @type {Array<string>}
+     * @memberof ApplyRuleToCustomerDto
+     */
+    chargeIds?: Array<string>;
+    /**
+     * Subscription IDs to apply the rule to (optional, if not provided, applies to all subscriptions)
+     * @type {Array<string>}
+     * @memberof ApplyRuleToCustomerDto
+     */
+    subscriptionIds?: Array<string>;
+    /**
+     * Specific subscription-charge combinations to apply the rule to
+     * @type {Array<SubscriptionChargeSelectionDto>}
+     * @memberof ApplyRuleToCustomerDto
+     */
+    subscriptionCharges?: Array<SubscriptionChargeSelectionDto>;
+}
+
+/**
+ * Check if a given object implements the ApplyRuleToCustomerDto interface.
+ */
+export function instanceOfApplyRuleToCustomerDto(value: object): value is ApplyRuleToCustomerDto {
+    if (!('customerId' in value) || value['customerId'] === undefined) return false;
+    return true;
+}
+
+export function ApplyRuleToCustomerDtoFromJSON(json: any): ApplyRuleToCustomerDto {
+    return ApplyRuleToCustomerDtoFromJSONTyped(json, false);
+}
+
+export function ApplyRuleToCustomerDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApplyRuleToCustomerDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'customerId': json['customerId'],
+        'unitIds': json['unitIds'] == null ? undefined : json['unitIds'],
+        'chargeIds': json['chargeIds'] == null ? undefined : json['chargeIds'],
+        'subscriptionIds': json['subscriptionIds'] == null ? undefined : json['subscriptionIds'],
+        'subscriptionCharges': json['subscriptionCharges'] == null ? undefined : ((json['subscriptionCharges'] as Array<any>).map(SubscriptionChargeSelectionDtoFromJSON)),
+    };
+}
+
+export function ApplyRuleToCustomerDtoToJSON(json: any): ApplyRuleToCustomerDto {
+    return ApplyRuleToCustomerDtoToJSONTyped(json, false);
+}
+
+export function ApplyRuleToCustomerDtoToJSONTyped(value?: ApplyRuleToCustomerDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'customerId': value['customerId'],
+        'unitIds': value['unitIds'],
+        'chargeIds': value['chargeIds'],
+        'subscriptionIds': value['subscriptionIds'],
+        'subscriptionCharges': value['subscriptionCharges'] == null ? undefined : ((value['subscriptionCharges'] as Array<any>).map(SubscriptionChargeSelectionDtoToJSON)),
+    };
+}
+

package/src/generated/models/apply-rule-to-customer.ts

@@ -0,0 +1,106 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { SubscriptionChargeSelection } from './subscription-charge-selection';
+import {
+    SubscriptionChargeSelectionFromJSON,
+    SubscriptionChargeSelectionFromJSONTyped,
+    SubscriptionChargeSelectionToJSON,
+    SubscriptionChargeSelectionToJSONTyped,
+} from './subscription-charge-selection';
+
+/**
+ * 
+ * @export
+ * @interface ApplyRuleToCustomer
+ */
+export interface ApplyRuleToCustomer {
+    /**
+     * Customer ID to apply the rule to
+     * @type {string}
+     * @memberof ApplyRuleToCustomer
+     */
+    customerId: string;
+    /**
+     * Unit IDs to apply the rule to (optional, if not provided, applies to all units)
+     * @type {Array<string>}
+     * @memberof ApplyRuleToCustomer
+     */
+    unitIds?: Array<string>;
+    /**
+     * Charge IDs to apply the rule to (legacy - use subscriptionCharges for precision)
+     * @type {Array<string>}
+     * @memberof ApplyRuleToCustomer
+     */
+    chargeIds?: Array<string>;
+    /**
+     * Subscription IDs to apply the rule to (optional, if not provided, applies to all subscriptions)
+     * @type {Array<string>}
+     * @memberof ApplyRuleToCustomer
+     */
+    subscriptionIds?: Array<string>;
+    /**
+     * Specific subscription-charge combinations to apply the rule to
+     * @type {Array<SubscriptionChargeSelection>}
+     * @memberof ApplyRuleToCustomer
+     */
+    subscriptionCharges?: Array<SubscriptionChargeSelection>;
+}
+
+/**
+ * Check if a given object implements the ApplyRuleToCustomer interface.
+ */
+export function instanceOfApplyRuleToCustomer(value: object): value is ApplyRuleToCustomer {
+    if (!('customerId' in value) || value['customerId'] === undefined) return false;
+    return true;
+}
+
+export function ApplyRuleToCustomerFromJSON(json: any): ApplyRuleToCustomer {
+    return ApplyRuleToCustomerFromJSONTyped(json, false);
+}
+
+export function ApplyRuleToCustomerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApplyRuleToCustomer {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'customerId': json['customerId'],
+        'unitIds': json['unitIds'] == null ? undefined : json['unitIds'],
+        'chargeIds': json['chargeIds'] == null ? undefined : json['chargeIds'],
+        'subscriptionIds': json['subscriptionIds'] == null ? undefined : json['subscriptionIds'],
+        'subscriptionCharges': json['subscriptionCharges'] == null ? undefined : ((json['subscriptionCharges'] as Array<any>).map(SubscriptionChargeSelectionFromJSON)),
+    };
+}
+
+export function ApplyRuleToCustomerToJSON(json: any): ApplyRuleToCustomer {
+    return ApplyRuleToCustomerToJSONTyped(json, false);
+}
+
+export function ApplyRuleToCustomerToJSONTyped(value?: ApplyRuleToCustomer | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'customerId': value['customerId'],
+        'unitIds': value['unitIds'],
+        'chargeIds': value['chargeIds'],
+        'subscriptionIds': value['subscriptionIds'],
+        'subscriptionCharges': value['subscriptionCharges'] == null ? undefined : ((value['subscriptionCharges'] as Array<any>).map(SubscriptionChargeSelectionToJSON)),
+    };
+}
+

package/src/generated/models/batch-rate-change-response-dto.ts

@@ -0,0 +1,137 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { RateChangeResponseDto } from './rate-change-response-dto';
+import {
+    RateChangeResponseDtoFromJSON,
+    RateChangeResponseDtoFromJSONTyped,
+    RateChangeResponseDtoToJSON,
+    RateChangeResponseDtoToJSONTyped,
+} from './rate-change-response-dto';
+
+/**
+ * 
+ * @export
+ * @interface BatchRateChangeResponseDto
+ */
+export interface BatchRateChangeResponseDto {
+    /**
+     * Rule ID that was applied
+     * @type {string}
+     * @memberof BatchRateChangeResponseDto
+     */
+    ruleId: string;
+    /**
+     * Rule name that was applied
+     * @type {string}
+     * @memberof BatchRateChangeResponseDto
+     */
+    ruleName: string;
+    /**
+     * Total number of subscriptions modified across all customers
+     * @type {number}
+     * @memberof BatchRateChangeResponseDto
+     */
+    totalSubscriptionsModified: number;
+    /**
+     * Total number of charges modified across all customers
+     * @type {number}
+     * @memberof BatchRateChangeResponseDto
+     */
+    totalChargesModified: number;
+    /**
+     * Total current rate before changes
+     * @type {number}
+     * @memberof BatchRateChangeResponseDto
+     */
+    totalCurrentRate: number;
+    /**
+     * Total new rate after changes
+     * @type {number}
+     * @memberof BatchRateChangeResponseDto
+     */
+    totalNewRate: number;
+    /**
+     * Overall percentage change across all subscriptions
+     * @type {number}
+     * @memberof BatchRateChangeResponseDto
+     */
+    overallPercentageChange: number;
+    /**
+     * Results for each customer
+     * @type {Array<RateChangeResponseDto>}
+     * @memberof BatchRateChangeResponseDto
+     */
+    customerResults: Array<RateChangeResponseDto>;
+}
+
+/**
+ * Check if a given object implements the BatchRateChangeResponseDto interface.
+ */
+export function instanceOfBatchRateChangeResponseDto(value: object): value is BatchRateChangeResponseDto {
+    if (!('ruleId' in value) || value['ruleId'] === undefined) return false;
+    if (!('ruleName' in value) || value['ruleName'] === undefined) return false;
+    if (!('totalSubscriptionsModified' in value) || value['totalSubscriptionsModified'] === undefined) return false;
+    if (!('totalChargesModified' in value) || value['totalChargesModified'] === undefined) return false;
+    if (!('totalCurrentRate' in value) || value['totalCurrentRate'] === undefined) return false;
+    if (!('totalNewRate' in value) || value['totalNewRate'] === undefined) return false;
+    if (!('overallPercentageChange' in value) || value['overallPercentageChange'] === undefined) return false;
+    if (!('customerResults' in value) || value['customerResults'] === undefined) return false;
+    return true;
+}
+
+export function BatchRateChangeResponseDtoFromJSON(json: any): BatchRateChangeResponseDto {
+    return BatchRateChangeResponseDtoFromJSONTyped(json, false);
+}
+
+export function BatchRateChangeResponseDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): BatchRateChangeResponseDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ruleId': json['ruleId'],
+        'ruleName': json['ruleName'],
+        'totalSubscriptionsModified': json['totalSubscriptionsModified'],
+        'totalChargesModified': json['totalChargesModified'],
+        'totalCurrentRate': json['totalCurrentRate'],
+        'totalNewRate': json['totalNewRate'],
+        'overallPercentageChange': json['overallPercentageChange'],
+        'customerResults': ((json['customerResults'] as Array<any>).map(RateChangeResponseDtoFromJSON)),
+    };
+}
+
+export function BatchRateChangeResponseDtoToJSON(json: any): BatchRateChangeResponseDto {
+    return BatchRateChangeResponseDtoToJSONTyped(json, false);
+}
+
+export function BatchRateChangeResponseDtoToJSONTyped(value?: BatchRateChangeResponseDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ruleId': value['ruleId'],
+        'ruleName': value['ruleName'],
+        'totalSubscriptionsModified': value['totalSubscriptionsModified'],
+        'totalChargesModified': value['totalChargesModified'],
+        'totalCurrentRate': value['totalCurrentRate'],
+        'totalNewRate': value['totalNewRate'],
+        'overallPercentageChange': value['overallPercentageChange'],
+        'customerResults': ((value['customerResults'] as Array<any>).map(RateChangeResponseDtoToJSON)),
+    };
+}
+

package/src/generated/models/batch-rate-change-response.ts

@@ -0,0 +1,137 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { RateChangeResponse } from './rate-change-response';
+import {
+    RateChangeResponseFromJSON,
+    RateChangeResponseFromJSONTyped,
+    RateChangeResponseToJSON,
+    RateChangeResponseToJSONTyped,
+} from './rate-change-response';
+
+/**
+ * 
+ * @export
+ * @interface BatchRateChangeResponse
+ */
+export interface BatchRateChangeResponse {
+    /**
+     * Rule ID that was applied
+     * @type {string}
+     * @memberof BatchRateChangeResponse
+     */
+    ruleId: string;
+    /**
+     * Rule name that was applied
+     * @type {string}
+     * @memberof BatchRateChangeResponse
+     */
+    ruleName: string;
+    /**
+     * Total number of subscriptions modified across all customers
+     * @type {number}
+     * @memberof BatchRateChangeResponse
+     */
+    totalSubscriptionsModified: number;
+    /**
+     * Total number of charges modified across all customers
+     * @type {number}
+     * @memberof BatchRateChangeResponse
+     */
+    totalChargesModified: number;
+    /**
+     * Total current rate before changes
+     * @type {number}
+     * @memberof BatchRateChangeResponse
+     */
+    totalCurrentRate: number;
+    /**
+     * Total new rate after changes
+     * @type {number}
+     * @memberof BatchRateChangeResponse
+     */
+    totalNewRate: number;
+    /**
+     * Overall percentage change across all subscriptions
+     * @type {number}
+     * @memberof BatchRateChangeResponse
+     */
+    overallPercentageChange: number;
+    /**
+     * Results for each customer
+     * @type {Array<RateChangeResponse>}
+     * @memberof BatchRateChangeResponse
+     */
+    customerResults: Array<RateChangeResponse>;
+}
+
+/**
+ * Check if a given object implements the BatchRateChangeResponse interface.
+ */
+export function instanceOfBatchRateChangeResponse(value: object): value is BatchRateChangeResponse {
+    if (!('ruleId' in value) || value['ruleId'] === undefined) return false;
+    if (!('ruleName' in value) || value['ruleName'] === undefined) return false;
+    if (!('totalSubscriptionsModified' in value) || value['totalSubscriptionsModified'] === undefined) return false;
+    if (!('totalChargesModified' in value) || value['totalChargesModified'] === undefined) return false;
+    if (!('totalCurrentRate' in value) || value['totalCurrentRate'] === undefined) return false;
+    if (!('totalNewRate' in value) || value['totalNewRate'] === undefined) return false;
+    if (!('overallPercentageChange' in value) || value['overallPercentageChange'] === undefined) return false;
+    if (!('customerResults' in value) || value['customerResults'] === undefined) return false;
+    return true;
+}
+
+export function BatchRateChangeResponseFromJSON(json: any): BatchRateChangeResponse {
+    return BatchRateChangeResponseFromJSONTyped(json, false);
+}
+
+export function BatchRateChangeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BatchRateChangeResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ruleId': json['ruleId'],
+        'ruleName': json['ruleName'],
+        'totalSubscriptionsModified': json['totalSubscriptionsModified'],
+        'totalChargesModified': json['totalChargesModified'],
+        'totalCurrentRate': json['totalCurrentRate'],
+        'totalNewRate': json['totalNewRate'],
+        'overallPercentageChange': json['overallPercentageChange'],
+        'customerResults': ((json['customerResults'] as Array<any>).map(RateChangeResponseFromJSON)),
+    };
+}
+
+export function BatchRateChangeResponseToJSON(json: any): BatchRateChangeResponse {
+    return BatchRateChangeResponseToJSONTyped(json, false);
+}
+
+export function BatchRateChangeResponseToJSONTyped(value?: BatchRateChangeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ruleId': value['ruleId'],
+        'ruleName': value['ruleName'],
+        'totalSubscriptionsModified': value['totalSubscriptionsModified'],
+        'totalChargesModified': value['totalChargesModified'],
+        'totalCurrentRate': value['totalCurrentRate'],
+        'totalNewRate': value['totalNewRate'],
+        'overallPercentageChange': value['overallPercentageChange'],
+        'customerResults': ((value['customerResults'] as Array<any>).map(RateChangeResponseToJSON)),
+    };
+}
+

package/src/generated/models/create-customer-status.ts

@@ -0,0 +1,99 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateCustomerStatus
+ */
+export interface CreateCustomerStatus {
+    /**
+     * User-defined status name
+     * @type {string}
+     * @memberof CreateCustomerStatus
+     */
+    name: string;
+    /**
+     * Order in the status sequence
+     * @type {number}
+     * @memberof CreateCustomerStatus
+     */
+    sequence: number;
+    /**
+     * Internal status categorisation
+     * @type {string}
+     * @memberof CreateCustomerStatus
+     */
+    knownStatus?: string | null;
+    /**
+     * Description of the status
+     * @type {string}
+     * @memberof CreateCustomerStatus
+     */
+    description?: string | null;
+    /**
+     * Colour for UI representation
+     * @type {string}
+     * @memberof CreateCustomerStatus
+     */
+    colour?: string | null;
+}
+
+/**
+ * Check if a given object implements the CreateCustomerStatus interface.
+ */
+export function instanceOfCreateCustomerStatus(value: object): value is CreateCustomerStatus {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('sequence' in value) || value['sequence'] === undefined) return false;
+    return true;
+}
+
+export function CreateCustomerStatusFromJSON(json: any): CreateCustomerStatus {
+    return CreateCustomerStatusFromJSONTyped(json, false);
+}
+
+export function CreateCustomerStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCustomerStatus {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'sequence': json['sequence'],
+        'knownStatus': json['knownStatus'] == null ? undefined : json['knownStatus'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'colour': json['colour'] == null ? undefined : json['colour'],
+    };
+}
+
+export function CreateCustomerStatusToJSON(json: any): CreateCustomerStatus {
+    return CreateCustomerStatusToJSONTyped(json, false);
+}
+
+export function CreateCustomerStatusToJSONTyped(value?: CreateCustomerStatus | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'sequence': value['sequence'],
+        'knownStatus': value['knownStatus'],
+        'description': value['description'],
+        'colour': value['colour'],
+    };
+}
+