@northflank/js-client 0.7.0 → 0.7.1-beta.0

package/dist/cjs/endpoints/get/addon/types.d.ts

@@ -1,48 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetAddonTypesResult = {
-    /** A list of available addon types. */
-    'addonTypes': {
-        /** The identifier for the addon type. Example: "redis" */
-        'type': string;
-        /** The name of the addon type. Example: "Redis" */
-        'name': string;
-        /** A description of the addon. Example: "Redis implements a distributed, in-memory key-value database with optional durability." */
-        'description': string;
-        /** A list of available versions of the addon type. */
-        'versions': string[];
-        /** Features supported by this addon type. */
-        'features'?: {
-            /** Whether this addon supports connection via TLS. */
-            'tls': boolean;
-            /** Whether this addon supports external connection. */
-            'externalAccess': boolean;
-        };
-        /** Details about resource options for the addon type. */
-        'resources': {
-            /** Details about storage size options for this addon. */
-            'storage': {
-                /** Available options for storage size for this addon, in MB. */
-                'options': number[];
-                /** The default storage value for this addon. Example: 1024 */
-                'default': number;
-            };
-            /** Details about replica count options for this addon. */
-            'replicas': {
-                /** Available options for replica counts for this addon. */
-                'options': number[];
-                /** The default replica count for this addon. Example: 1 */
-                'default': number;
-            };
-        };
-    }[];
-};
-export declare type GetAddonTypesCall = (opts: GetAddonTypesRequest) => Promise<ApiCallResponse<GetAddonTypesResult>>;
-export declare type GetAddonTypesRequest = {};
-/** Gets information about the available addon types */
-export declare class GetAddonTypesEndpoint extends GetApiEndpoint<GetAddonTypesRequest, GetAddonTypesResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetAddonTypesRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/addon/version.d.ts

@@ -1,53 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetAddonVersionResult = {
-    /** The version of the addon running. Example: "4.2.14" */
-    'version': string;
-    /** Available versions that the addon can be upgraded to. */
-    'upgradeTo': {
-        /** The version of the addon to upgrade to. Example: "4.2.15" */
-        'version': string;
-        /** Whether the version is a major or minor version. Example: "minor" */
-        'type': 'major' | 'minor' | 'patch';
-    }[];
-    /** The support status of the current addon version. Example: "deprecated" */
-    'lifecycleStatus': 'active' | 'deprecated' | 'discontinued';
-    /** The date that the current addon version will be discontinued. Example: "01.08.2021" */
-    'discontinuedBy'?: string;
-    /** Data about the upgrade history of this addon. */
-    'upgradeHistory': {
-        /** The unique identifier of the addon upgrade. Example: "611d0da52cd838bbdeec4792" */
-        'upgradeId': string;
-        /** Details about the upgrade status. */
-        'status': {
-            /** The status of the addon upgrade. Example: "completed" */
-            'status': 'scheduled' | 'in-progress' | 'completed' | 'aborting' | 'aborted' | 'failed' | 'not-supported';
-        };
-        /** The time the upgrade was initiated. Example: "2021-08-18 13:39:49.475Z" */
-        'createdAt': string;
-        /** Whether the version updated to is a major or minor version. Example: "minor" */
-        'upgradeType': 'major' | 'minor' | 'patch';
-        /** The version upgraded from. Example: "4.2.14" */
-        'previousVersion': string;
-        /** The version upgraded to. Example: "4.2.15" */
-        'newVersion': string;
-        /** The time the upgrade was completed. Example: "2021-08-18T13:40:51.685Z" */
-        'completedAt'?: string;
-    }[];
-};
-export declare type GetAddonVersionCall = (opts: GetAddonVersionRequest) => Promise<ApiCallResponse<GetAddonVersionResult>>;
-export declare type GetAddonVersionRequest = {
-    parameters: GetAddonVersionParameters;
-};
-export declare type GetAddonVersionParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the addon */
-    'addonId': string;
-};
-/** Gets details about the current addon version including available upgrades and upgrade history. */
-export declare class GetAddonVersionEndpoint extends GetApiEndpoint<GetAddonVersionRequest, GetAddonVersionResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetAddonVersionRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/addon.d.ts

@@ -1,71 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetAddonResult = {
-    /** Identifier for the addon. Example: "example-addon" */
-    'id': string;
-    /** Addon name. Example: "Example Addon" */
-    'name': string;
-    /** Full identifier for the addon. Example: "/example-user/default-project/example-addon" */
-    'appId': string;
-    /** A short description of the addon. Example: "This is the addon description" */
-    'description'?: string;
-    /** The time the addon was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-    /** The current state of the addon. Example: "running" */
-    'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'backup' | 'restore' | 'failed' | 'deleting' | 'deleted';
-    /** Details about the addon's specifications. */
-    'spec': {
-        /** The type of the addon Example: "mongodb" */
-        'type': string;
-        /** Details about the addon configuration. */
-        'config': {
-            /** The version of the addon running. Example: "4.2.14" */
-            'versionTag': string;
-            /** The support status of the current addon version. Example: "active" */
-            'lifecycleStatus': 'active' | 'deprecated' | 'discontinued';
-            /** Details about the addon deployment. */
-            'deployment': {
-                /** The number of replicas running for this addon. Example: 1 */
-                'replicas': number;
-                /** The type of storage used by the addon. Example: "ssd" */
-                'storageClass': string;
-                /** The size of the addon storage, in MB. Example: 4096 */
-                'storageSize': number;
-                /** The deployment plan used by the addon. Example: "nf-compute-20" */
-                'planId': string;
-                /** The region where the addon is deployed. Example: "europe-west" */
-                'region': string;
-            };
-            /** Details about the addon networking settings. */
-            'networking': {
-                /** Whether this addon is provisioned with a TLS certificate. Example: true */
-                'tlsEnabled': boolean;
-                /** Whether this addon is publicly accessible via the internet. Example: true */
-                'externalAccessEnabled': boolean;
-                /** An array of IP policy rules. */
-                'ipPolicies'?: {
-                    /** An IP address used by this rule. Example: "127.0.0.1" */
-                    'address': string;
-                    /** The action for this rule. Example: "ALLOW" */
-                    'action': 'DENY' | 'ALLOW';
-                }[];
-            };
-        };
-    };
-};
-export declare type GetAddonCall = (opts: GetAddonRequest) => Promise<ApiCallResponse<GetAddonResult>>;
-export declare type GetAddonRequest = {
-    parameters: GetAddonParameters;
-};
-export declare type GetAddonParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the addon */
-    'addonId': string;
-};
-/** Gets information about the given addon */
-export declare class GetAddonEndpoint extends GetApiEndpoint<GetAddonRequest, GetAddonResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetAddonRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/cluster.d.ts

@@ -1,55 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetClusterResult = {
-    /** Identifier for the cluster. Example: "gcp-cluster-1" */
-    'id': string;
-    /** The name of the cluster. Example: "GCP Cluster 1" */
-    'name': string;
-    /** A short description of the cluster. Example: "The cluster description" */
-    'description'?: string;
-    /** The cloud provider to which this cluster belongs to. Example: "gcp" */
-    'provider'?: string;
-    /** ID of the provider integration used by this cluster. Example: "gcp-integration" */
-    'integrationId': string;
-    'nodePools': {
-        'availabilityZones'?: string[];
-        'nodeTypes': string[];
-        'nodeCount': number;
-        'autoscaling'?: {
-            'enabled'?: boolean;
-            'min'?: number;
-            'max'?: number;
-        };
-        /** Configures node pool with preemptible / spot instances if enabled. */
-        'preemptible'?: boolean;
-        'diskType'?: string;
-        'diskSize': number;
-        /** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
-        'id'?: string;
-    };
-    'status'?: {
-        'state'?: {
-            'state'?: string;
-            'transitionTime'?: string;
-        };
-        'nextUpdateAfter'?: string;
-    };
-    /** The time the cluster was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-    /** Indicates if provider resource deletion has been requested by the user. */
-    'deletionRequested': boolean;
-};
-export declare type GetClusterCall = (opts: GetClusterRequest) => Promise<ApiCallResponse<GetClusterResult>>;
-export declare type GetClusterRequest = {
-    parameters: GetClusterParameters;
-};
-export declare type GetClusterParameters = {
-    /** ID of the cluster */ 'clusterId': string;
-};
-/** Get information about the given cluster */
-export declare class GetClusterEndpoint extends GetApiEndpoint<GetClusterRequest, GetClusterResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetClusterRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/dnsId.d.ts

@@ -1,15 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetDnsidResult = {
-    /** The partially random string associated with the authenticated account, used for generating DNS entries. Example: "exam-1234" */
-    'dns': string;
-};
-export declare type GetDnsidCall = (opts: GetDnsidRequest) => Promise<ApiCallResponse<GetDnsidResult>>;
-export declare type GetDnsidRequest = {};
-/** Returns the partially random string used when generating host names for the authenticated account. */
-export declare class GetDnsidEndpoint extends GetApiEndpoint<GetDnsidRequest, GetDnsidResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetDnsidRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/domain.d.ts

@@ -1,33 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetDomainResult = {
-    /** The domain name. Example: "example.com" */
-    'name': string;
-    /** The status of the domain verification. Example: "verified" */
-    'status': 'pending' | 'verified';
-    /** The hostname to add to your domain's DNS records as a TXT record to verify the domain. Example: "nfverify1608026055" */
-    'hostname': string;
-    /** The token to add as the content of the TXT record to verify the domain. Example: "e596987b52855a4a773ef580ce2985d7746b37ce8b2a443d20fa27b913d8f57" */
-    'token': string;
-    /** A list of subdomains added to this domain. */
-    'subdomains': {
-        /** The subdomain added, or -default for the empty subdomain. Example: "app" */
-        'name': string;
-        /** The full domain including the subdomain. Example: "app.example.com" */
-        'fullName': string;
-    }[];
-};
-export declare type GetDomainCall = (opts: GetDomainRequest) => Promise<ApiCallResponse<GetDomainResult>>;
-export declare type GetDomainRequest = {
-    parameters: GetDomainParameters;
-};
-export declare type GetDomainParameters = {
-    /** Name of the domain */ 'domain': string;
-};
-/** Gets details about domain */
-export declare class GetDomainEndpoint extends GetApiEndpoint<GetDomainRequest, GetDomainResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetDomainRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/integration.d.ts

@@ -1,37 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../api-endpoint';
-export declare type GetIntegrationResult = {
-    /** Identifier for the integration. Example: "gcp-integration" */
-    'id': string;
-    /** The name of the integration. Example: "GCP integration" */
-    'name': string;
-    /** A short description of the integration. Example: "The integration description" */
-    'description'?: string;
-    /** Cloud provider credential input, required fields dependent on which provider is chosen. */
-    'credentials': {
-        /** Contents of a GCP key file. */
-        'keyfileJson'?: string;
-        /** AWS access key. */
-        'accessKey'?: string;
-        /** AWS secret key. */
-        'secretKey'?: string;
-        /** DO API key. */
-        'apiKey'?: string;
-    };
-    /** The time the integration was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-};
-export declare type GetIntegrationCall = (opts: GetIntegrationRequest) => Promise<ApiCallResponse<GetIntegrationResult>>;
-export declare type GetIntegrationRequest = {
-    parameters: GetIntegrationParameters;
-};
-export declare type GetIntegrationParameters = {
-    /** ID of the provider integration */ 'integrationId': string;
-};
-/** Get information about the given integration */
-export declare class GetIntegrationEndpoint extends GetApiEndpoint<GetIntegrationRequest, GetIntegrationResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetIntegrationRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/invoice/details.d.ts

@@ -1,139 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetInvoiceDetailsResult = {
-    /** Information about the billing period of the invoice. */
-    'period': {
-        /** Unix timestamp of the start of the billing period. Example: 1655823815 */
-        'start': number;
-        /** Unix timestamp of the end of the billing period. Example: 1655910214 */
-        'end': number;
-    };
-    /** Currency code for the currency the invoice is billed in. Example: "usd" */
-    'currency': string;
-    /** Total cost of the invoice, in cents, including tax. Example: 1200 */
-    'total': number;
-    /** Total cost of the invoice, in cents, excluding tax. Example: 1000 */
-    'subTotal': number;
-    /** If `timestamp` is passed in, whether the invoice has been paid. */
-    'paid'?: boolean;
-    /** Details about the tax on the invoice. */
-    'tax': {
-        /** Percentage of subtotal to be applied as tax. Example: 20 */
-        'percent': number;
-        /** Value of the tax on the invoice. Example: 200 */
-        'value': number;
-    };
-    /** An array of projects billed in this invoice. If `projectId` is passed in, only projects with a `projectId` matching the value will be returned. */
-    'projects': {
-        /** ID of the project. Example: "default-project" */
-        'projectId': string;
-        /** Name of the project Example: "Default Project" */
-        'projectName': string;
-        /** Duration the project has been running in this billing period, in seconds. Example: 259200 */
-        'duration': string;
-        /** An array of objects belonging to this project that are billed in this invoice. If `addonId`, `serviceId` or `jobId` are passed in, only objects matching that ID will be returned. */
-        'items': {
-            /** Duration the object has been running in this billing period, in seconds. Example: 172800 */
-            'duration': string;
-            /** Details about the price of a object, broken down by resource type. */
-            'price': {
-                /** Price of CPU usage for this object, in cents. Example: 200 */
-                'cpu': number;
-                /** Price of memory usage for this object, in cents. Example: 200 */
-                'memory': number;
-                /** Price of storage usage for this object, in cents. Example: 200 */
-                'storage': number;
-                /** Total price for this object, in cents. Example: 600 */
-                'total': number;
-            };
-            /** The ID of the object. Example: "example-service" */
-            'nfObjectId': string;
-            /** The name of the object. Example: "Example Service" */
-            'nfObjectName': string;
-            /** The type of the object. Example: "service" */
-            'nfObjectType': 'job' | 'service' | 'addon' | 'volume';
-        }[];
-        /** Details about the price of a project, broken down by resource type. */
-        'price': {
-            /** Price of CPU usage for this project, in cents. Example: 200 */
-            'cpu': number;
-            /** Price of memory usage for this project, in cents. Example: 200 */
-            'memory': number;
-            /** Price of storage usage for this project, in cents. Example: 200 */
-            'storage': number;
-            /** Total price for this project, in cents. Example: 600 */
-            'total': number;
-        };
-        /** Details about the price of a project, broken down by object type. */
-        'objectTypeTotals': {
-            'addon'?: {
-                /** Details about the price for all addons in this project, broken down by resource type. */
-                'price'?: {
-                    /** Price of CPU usage for all addons in this project, in cents. Example: 200 */
-                    'cpu': number;
-                    /** Price of memory usage for all addons in this project, in cents. Example: 200 */
-                    'memory': number;
-                    /** Price of storage usage for all addons in this project, in cents. Example: 200 */
-                    'storage': number;
-                    /** Total price for all addons in this project, in cents. Example: 600 */
-                    'total': number;
-                };
-                /** Duration addons have been running in this billing period, in seconds. Example: 172800 */
-                'duration': number;
-            };
-            'service'?: {
-                /** Details about the price for all services in this project, broken down by resource type. */
-                'price'?: {
-                    /** Price of CPU usage for all services in this project, in cents. Example: 200 */
-                    'cpu': number;
-                    /** Price of memory usage for all services in this project, in cents. Example: 200 */
-                    'memory': number;
-                    /** Price of storage usage for all services in this project, in cents. Example: 200 */
-                    'storage': number;
-                    /** Total price for all services in this project, in cents. Example: 600 */
-                    'total': number;
-                };
-                /** Duration services have been running in this billing period, in seconds. Example: 172800 */
-                'duration': number;
-            };
-            'job'?: {
-                /** Details about the price for all jobs in this project, broken down by resource type. */
-                'price'?: {
-                    /** Price of CPU usage for all jobs in this project, in cents. Example: 200 */
-                    'cpu': number;
-                    /** Price of memory usage for all jobs in this project, in cents. Example: 200 */
-                    'memory': number;
-                    /** Price of storage usage for all jobs in this project, in cents. Example: 200 */
-                    'storage': number;
-                    /** Total price for all jobs in this project, in cents. Example: 600 */
-                    'total': number;
-                };
-                /** Duration jobs have been running in this billing period, in seconds. Example: 172800 */
-                'duration': number;
-            };
-        };
-    }[];
-};
-export declare type GetInvoiceDetailsCall = (opts: GetInvoiceDetailsRequest) => Promise<ApiCallResponse<GetInvoiceDetailsResult>>;
-export declare type GetInvoiceDetailsRequest = {
-    options?: GetInvoiceDetailsOptions;
-};
-export declare type GetInvoiceDetailsOptions = {
-    /** Timestamp of an invoice. If passed in, this endpoint will return details about the invoice that time belongs to. */
-    'timestamp'?: number;
-    /** ID of a project. If passed in, only details about that project will be returned. */
-    'projectId'?: string;
-    /** ID of a addon. If passed in, only details about that addon will be returned. */
-    'addonId'?: string;
-    /** ID of a service. If passed in, only details about that service will be returned. */
-    'serviceId'?: string;
-    /** ID of a job. If passed in, only details about that job will be returned. */
-    'jobId'?: string;
-};
-/** Get details about an invoice. If `timestamp` is passed in as a query parameter, this endpoint returns details about the invoice containing that timestamp. Otherwise, returns a preview invoice displaying billing data from after the most recent invoice. */
-export declare class GetInvoiceDetailsEndpoint extends GetApiEndpoint<GetInvoiceDetailsRequest, GetInvoiceDetailsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetInvoiceDetailsRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/branches.d.ts

@@ -1,49 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobBranchesResult = {
-    /** A list of branches for this repository. */
-    'branches'?: {
-        /** Name of the branch. Example: "main" */
-        'name': string;
-        'id': string;
-        /** Details about the most recent commit on the branch. */
-        'commit': {
-            /** SHA identifier of the commit. Example: "f8aca180e989be62cba71db629d2ede05f2d10c4" */
-            'sha': string;
-            /** Details about the commit author. */
-            'author': {
-                /** The login of the commit author. Example: "northflank" */
-                'login': string;
-            };
-            /** Commit message of the commit. Example: "Initial commit" */
-            'message'?: string;
-            /** Timestamp of the commit. Example: "2021-09-17T14:04:39.000Z" */
-            'date'?: string;
-        };
-    }[];
-};
-export declare type GetJobBranchesCall = (opts: GetJobBranchesRequest) => Promise<ApiCallResponse<GetJobBranchesResult>>;
-export declare type GetJobBranchesRequest = {
-    parameters: GetJobBranchesParameters;
-    options?: GetJobBranchesOptions;
-};
-export declare type GetJobBranchesParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-export declare type GetJobBranchesOptions = {
-    /** The number of results to display per request. Maximum of 100 results per page. */
-    'per_page'?: number;
-    /** The page number to access. */
-    'page'?: number;
-    /** The cursor returned from the previous page of results, used to request the next page. */
-    'cursor'?: string;
-};
-/** Gets information about the branches of the given job. */
-export declare class GetJobBranchesEndpoint extends GetApiEndpoint<GetJobBranchesRequest, GetJobBranchesResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobBranchesRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/build.d.ts

@@ -1,42 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobBuildResult = {
-    /** ID of the build. Example: "joyous-view-6290" */
-    'id': string;
-    /** Name of the branch the built commit belongs to. Example: "main" */
-    'branch'?: string;
-    /** ID of the pull request the commit belongs to. */
-    'pullRequestId'?: number;
-    /** The status of the build. Example: "SUCCESS" */
-    'status'?: 'PENDING' | 'STARTING' | 'CLONING' | 'BUILDING' | 'UPLOADING' | 'ABORTED' | 'FAILURE' | 'SUCCESS' | 'CRASHED';
-    /** The sha of the built commit. Example: "12c15e7ee25fd78f567ebf87f9178b8ad70025b3" */
-    'sha'?: string;
-    /** Whether the build has finished. Example: true */
-    'concluded'?: boolean;
-    /** Timestamp of the build initiation. Example: "2021-07-28T15:55:38.296Z" */
-    'createdAt'?: string;
-    /** Whether the build was successful. Example: true */
-    'success'?: boolean;
-    /** Description of the build status. Example: "Image successfully built" */
-    'message'?: string;
-    /** Timestamp of the build concluding. Example: 1606237973 */
-    'buildConcludedAt'?: number;
-};
-export declare type GetJobBuildCall = (opts: GetJobBuildRequest) => Promise<ApiCallResponse<GetJobBuildResult>>;
-export declare type GetJobBuildRequest = {
-    parameters: GetJobBuildParameters;
-};
-export declare type GetJobBuildParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-    /** ID of the job build */
-    'buildId': string;
-};
-/** Gets information about a build for the job */
-export declare class GetJobBuildEndpoint extends GetApiEndpoint<GetJobBuildRequest, GetJobBuildResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobBuildRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/buildArgumentDetails.d.ts

@@ -1,71 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobBuildargumentdetailsResult = {
-    /** Details about all the secrets accessible by the service. */
-    'buildArguments': {
-        /** A stored secret and details about it and its value. This can have the name of any saved secret. */
-        'MY_VARIABLE_NAME'?: {
-            /** The value of the secret. Example: "abcdef123456" */
-            'value': any;
-            /** The ID of the secret group the secret is inherited from, if applicable. Example: "example-secret" */
-            'inheritedFrom'?: string;
-            /** The ID of the addon the secret is inherited from, if applicable. Example: "example-addon" */
-            'addonId'?: string;
-            /** The priority of the secret group the secret is inherited from, if applicable. Example: 10 */
-            'priority'?: number;
-            /** An array containing data about other places the secret has been inherited from, but that are not being used as a secret with the same key exists with a higher priority. */
-            'overriding': {
-                /** The value of the secret. Example: "ffffffffffff" */
-                'value': any;
-                /** The ID of the secret group the secret is inherited from. Example: "secret-2" */
-                'inheritedFrom': string;
-                /** The ID of the addon the secret is inherited from, if applicable. Example: "addon-2" */
-                'addonId'?: string;
-                /** The priority of the secret group the secret is inherited from. */
-                'priority': number;
-            }[];
-        };
-    };
-    /** Details about all the secrets accessible by the service. */
-    'buildFiles': {
-        /** A stored secret and details about it and its value. This can have the name of any saved secret. */
-        '/dir/fileName'?: {
-            /** The value of the secret. Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
-            'value': {
-                /** base64 encoded string of the file contents Example: "VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=" */
-                'data'?: string;
-                /** Original encoding of the file Example: "utf-8" */
-                'encoding'?: string;
-            };
-            /** The ID of the secret group the secret is inherited from, if applicable. Example: "example-secret" */
-            'inheritedFrom'?: string;
-            /** The priority of the secret group the secret is inherited from, if applicable. Example: 10 */
-            'priority'?: number;
-            /** An array containing data about other places the file has been inherited from, but that are not being used as a secret with the same file path exists with a higher priority. */
-            'overriding': {
-                /** The value of the secret. Example: "ffffffffffff" */
-                'value': any;
-                /** The ID of the secret group the secret is inherited from. Example: "secret-2" */
-                'inheritedFrom': string;
-                /** The priority of the secret group the secret is inherited from. */
-                'priority': number;
-            }[];
-        };
-    };
-};
-export declare type GetJobBuildargumentdetailsCall = (opts: GetJobBuildargumentdetailsRequest) => Promise<ApiCallResponse<GetJobBuildargumentdetailsResult>>;
-export declare type GetJobBuildargumentdetailsRequest = {
-    parameters: GetJobBuildargumentdetailsParameters;
-};
-export declare type GetJobBuildargumentdetailsParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-/** Get details about the build arguments accessible by the given job. Also requires the permission 'Project > Secrets > General > Read' */
-export declare class GetJobBuildargumentdetailsEndpoint extends GetApiEndpoint<GetJobBuildargumentdetailsRequest, GetJobBuildargumentdetailsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobBuildargumentdetailsRequest) => string;
-    body: () => undefined;
-}

package/dist/cjs/endpoints/get/job/buildArguments.d.ts

@@ -1,29 +0,0 @@
-import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
-export declare type GetJobBuildargumentsResult = {
-    /** The build arguments, formatted as a JSON object. If the `show` parameter is set to `this`, this will only contain secrets saved to this entity. If the `show` parameter is set to `inherited`, this will only contain secrets inherited from linked secret groups. Otherwise, this will contain both. Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
-    'buildArguments': any;
-    /** The build secret files, formatted as a JSON object. If the `show` parameter is set to `this`, this will only contain files saved to this entity. If the `show` parameter is set to `inherited`, this will only contain files inherited from linked secret groups. Otherwise, this will contain both. Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
-    'buildFiles': any;
-};
-export declare type GetJobBuildargumentsCall = (opts: GetJobBuildargumentsRequest) => Promise<ApiCallResponse<GetJobBuildargumentsResult>>;
-export declare type GetJobBuildargumentsRequest = {
-    parameters: GetJobBuildargumentsParameters;
-    options?: GetJobBuildargumentsOptions;
-};
-export declare type GetJobBuildargumentsParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the job */
-    'jobId': string;
-};
-export declare type GetJobBuildargumentsOptions = {
-    /** Which secrets to display - if set to `this` only the group's secrets are displayed, if set to `inherited` only secrets from linked addons are displayed, if set to `all` or not provided, both are displayed. */
-    'show'?: string;
-};
-/** Gets the build arguments of the given job. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed. */
-export declare class GetJobBuildargumentsEndpoint extends GetApiEndpoint<GetJobBuildargumentsRequest, GetJobBuildargumentsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: GetJobBuildargumentsRequest) => string;
-    body: () => undefined;
-}