Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release: 8.8.0 #420

Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
feat(api): add drm configuration endpoints (#424)
stainless-app[bot] authored and stainless-bot committed Jun 14, 2024
commit 69e3fc9d069b91f7d4c0f967e8f2c4d170c5a7d3
2 changes: 1 addition & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
configured_endpoints: 95
configured_endpoints: 97
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/mux%2Fmux-6aab47a3857727b9d53429d9b367c0fbd1e7d86e42e4c59335bab5770907d18c.yml
11 changes: 11 additions & 0 deletions api.md
Original file line number Diff line number Diff line change
@@ -177,6 +177,17 @@ Methods:
- <code title="put /video/v1/web-inputs/{WEB_INPUT_ID}/shutdown">client.video.webInputs.<a href="./src/resources/video/web-inputs.ts">shutdown</a>(webInputId) -> WebInputShutdownResponse</code>
- <code title="put /video/v1/web-inputs/{WEB_INPUT_ID}/url">client.video.webInputs.<a href="./src/resources/video/web-inputs.ts">updateURL</a>(webInputId, { ...params }) -> WebInputUpdateURLResponse</code>

## DrmConfigurations

Types:

- <code><a href="./src/resources/video/drm-configurations.ts">DrmConfiguration</a></code>

Methods:

- <code title="get /video/v1/drm-configurations/{DRM_CONFIGURATION_ID}">client.video.drmConfigurations.<a href="./src/resources/video/drm-configurations.ts">retrieve</a>(drmConfigurationId) -> DrmConfiguration</code>
- <code title="get /video/v1/drm-configurations">client.video.drmConfigurations.<a href="./src/resources/video/drm-configurations.ts">list</a>({ ...params }) -> DrmConfigurationsBasePage</code>

# Data

## Dimensions
58 changes: 58 additions & 0 deletions src/resources/video/drm-configurations.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import * as Core from '@mux/mux-node/core';
import { APIResource } from '@mux/mux-node/resource';
import { isRequestOptions } from '@mux/mux-node/core';
import * as DrmConfigurationsAPI from '@mux/mux-node/resources/video/drm-configurations';
import { BasePage, type BasePageParams } from '@mux/mux-node/pagination';

export class DrmConfigurations extends APIResource {
/**
* Retrieves a single DRM Configuration.
*/
retrieve(drmConfigurationId: string, options?: Core.RequestOptions): Core.APIPromise<DrmConfiguration> {
return (
this._client.get(`/video/v1/drm-configurations/${drmConfigurationId}`, options) as Core.APIPromise<{
data: DrmConfiguration;
}>
)._thenUnwrap((obj) => obj.data);
}

/**
* Returns a list of DRM Configurations
*/
list(
query?: DrmConfigurationListParams,
options?: Core.RequestOptions,
): Core.PagePromise<DrmConfigurationsBasePage, DrmConfiguration>;
list(options?: Core.RequestOptions): Core.PagePromise<DrmConfigurationsBasePage, DrmConfiguration>;
list(
query: DrmConfigurationListParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.PagePromise<DrmConfigurationsBasePage, DrmConfiguration> {
if (isRequestOptions(query)) {
return this.list({}, query);
}
return this._client.getAPIList('/video/v1/drm-configurations', DrmConfigurationsBasePage, {
query,
...options,
});
}
}

export class DrmConfigurationsBasePage extends BasePage<DrmConfiguration> {}

export interface DrmConfiguration {
/**
* Unique identifier for the DRM Configuration. Max 255 characters.
*/
id: string;
}

export interface DrmConfigurationListParams extends BasePageParams {}

export namespace DrmConfigurations {
export import DrmConfiguration = DrmConfigurationsAPI.DrmConfiguration;
export import DrmConfigurationsBasePage = DrmConfigurationsAPI.DrmConfigurationsBasePage;
export import DrmConfigurationListParams = DrmConfigurationsAPI.DrmConfigurationListParams;
}
6 changes: 6 additions & 0 deletions src/resources/video/index.ts
Original file line number Diff line number Diff line change
@@ -41,6 +41,12 @@ export {
DeliveryReportsPageWithTotal,
DeliveryUsage,
} from './delivery-usage';
export {
DrmConfiguration,
DrmConfigurationListParams,
DrmConfigurationsBasePage,
DrmConfigurations,
} from './drm-configurations';
export {
LiveStream,
SimulcastTarget,
8 changes: 8 additions & 0 deletions src/resources/video/video.ts
Original file line number Diff line number Diff line change
@@ -3,6 +3,7 @@
import { APIResource } from '@mux/mux-node/resource';
import * as AssetsAPI from '@mux/mux-node/resources/video/assets';
import * as DeliveryUsageAPI from '@mux/mux-node/resources/video/delivery-usage';
import * as DrmConfigurationsAPI from '@mux/mux-node/resources/video/drm-configurations';
import * as LiveStreamsAPI from '@mux/mux-node/resources/video/live-streams';
import * as PlaybackIDsAPI from '@mux/mux-node/resources/video/playback-ids';
import * as PlaybackRestrictionsAPI from '@mux/mux-node/resources/video/playback-restrictions';
@@ -23,6 +24,9 @@ export class Video extends APIResource {
new TranscriptionVocabulariesAPI.TranscriptionVocabularies(this._client);
uploads: UploadsAPI.Uploads = new UploadsAPI.Uploads(this._client);
webInputs: WebInputsAPI.WebInputs = new WebInputsAPI.WebInputs(this._client);
drmConfigurations: DrmConfigurationsAPI.DrmConfigurations = new DrmConfigurationsAPI.DrmConfigurations(
this._client,
);
}

export namespace Video {
@@ -107,4 +111,8 @@ export namespace Video {
export import WebInputCreateParams = WebInputsAPI.WebInputCreateParams;
export import WebInputListParams = WebInputsAPI.WebInputListParams;
export import WebInputUpdateURLParams = WebInputsAPI.WebInputUpdateURLParams;
export import DrmConfigurations = DrmConfigurationsAPI.DrmConfigurations;
export import DrmConfiguration = DrmConfigurationsAPI.DrmConfiguration;
export import DrmConfigurationsBasePage = DrmConfigurationsAPI.DrmConfigurationsBasePage;
export import DrmConfigurationListParams = DrmConfigurationsAPI.DrmConfigurationListParams;
}
55 changes: 55 additions & 0 deletions tests/api-resources/video/drm-configurations.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import Mux from '@mux/mux-node';
import { Response } from 'node-fetch';

const mux = new Mux({
tokenId: 'my token id',
tokenSecret: 'my secret',
baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
});

describe('resource drmConfigurations', () => {
test('retrieve', async () => {
const responsePromise = mux.video.drmConfigurations.retrieve('string');
const rawResponse = await responsePromise.asResponse();
expect(rawResponse).toBeInstanceOf(Response);
const response = await responsePromise;
expect(response).not.toBeInstanceOf(Response);
const dataAndResponse = await responsePromise.withResponse();
expect(dataAndResponse.data).toBe(response);
expect(dataAndResponse.response).toBe(rawResponse);
});

test('retrieve: request options instead of params are passed correctly', async () => {
// ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
await expect(
mux.video.drmConfigurations.retrieve('string', { path: '/_stainless_unknown_path' }),
).rejects.toThrow(Mux.NotFoundError);
});

test('list', async () => {
const responsePromise = mux.video.drmConfigurations.list();
const rawResponse = await responsePromise.asResponse();
expect(rawResponse).toBeInstanceOf(Response);
const response = await responsePromise;
expect(response).not.toBeInstanceOf(Response);
const dataAndResponse = await responsePromise.withResponse();
expect(dataAndResponse.data).toBe(response);
expect(dataAndResponse.response).toBe(rawResponse);
});

test('list: request options instead of params are passed correctly', async () => {
// ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
await expect(mux.video.drmConfigurations.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
Mux.NotFoundError,
);
});

test('list: request options and params are passed correctly', async () => {
// ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
await expect(
mux.video.drmConfigurations.list({ limit: 0, page: 0 }, { path: '/_stainless_unknown_path' }),
).rejects.toThrow(Mux.NotFoundError);
});
});