Skip to content

Feat/ Add Phone Template Support #1139

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.

Sign up for GitHub

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

Merged
tanya732 merged 3 commits into from
Jul 22, 2025
Merged

Feat/ Add Phone Template Support #1139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1299727
Feat/ Add Phone Template Support
tanya732 Jul 22, 2025
0587496
Fixed lint error
tanya732 Jul 22, 2025
d6f4a61
Refactored tests
tanya732 Jul 22, 2025
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
180 changes: 180 additions & 0 deletions src/management/__generated/managers/branding-manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,34 @@ import * as runtime from '../../../lib/runtime.js';
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
import type {
CreatePhoneProviderRequest,
CreatePhoneTemplateRequestContent,
CreatePhoneTemplateResponseContent,
GetBranding200Response,
GetBrandingPhoneProviders200Response,
GetBrandingPhoneProviders200ResponseProvidersInner,
GetPhoneTemplateResponseContent,
GetUniversalLogin200Response,
ListPhoneTemplatesResponseContent,
PatchBrandingRequest,
PostBrandingTheme200Response,
PostBrandingThemeRequest,
PutUniversalLoginRequest,
ResetPhoneTemplateResponseContent,
UpdatePhoneProviderRequest,
UpdatePhoneTemplateRequestContent,
UpdatePhoneTemplateResponseContent,
DeleteBrandingThemeRequest,
DeletePhoneProviderRequest,
DeletePhoneTemplateRequest,
GetBrandingPhoneProvidersRequest,
GetBrandingThemeRequest,
GetPhoneProviderRequest,
GetPhoneTemplateRequest,
GetPhoneTemplatesRequest,
PatchBrandingThemeRequest,
ResetPhoneTemplateRequest,
UpdatePhoneProviderOperationRequest,
UpdatePhoneTemplateRequest,
} from '../models/index.js';

const { BaseAPI } = runtime;
Expand Down Expand Up @@ -55,6 +67,32 @@ export class BrandingManager extends BaseAPI {
return runtime.JSONApiResponse.fromResponse(response);
}

/**
* Create a phone notification template
*
* @throws {RequiredError}
*/
async createPhoneTemplate(
bodyParameters: CreatePhoneTemplateRequestContent,
initOverrides?: InitOverride
): Promise<ApiResponse<CreatePhoneTemplateResponseContent>> {
const headerParameters: runtime.HTTPHeaders = {};

headerParameters['Content-Type'] = 'application/json';

const response = await this.request(
{
path: `/branding/phone/templates`,
method: 'POST',
headers: headerParameters,
body: bodyParameters,
},
initOverrides
);

return runtime.JSONApiResponse.fromResponse(response);
}

/**
* Delete branding theme.
* Delete branding theme
Expand Down Expand Up @@ -108,6 +146,31 @@ export class BrandingManager extends BaseAPI {
return runtime.VoidApiResponse.fromResponse(response);
}

/**
* Delete a phone notification template
*
* @throws {RequiredError}
*/
async deletePhoneTemplate(
requestParameters: DeletePhoneTemplateRequest,
initOverrides?: InitOverride
): Promise<ApiResponse<void>> {
runtime.validateRequiredRequestParams(requestParameters, ['id']);

const response = await this.request(
{
path: `/branding/phone/templates/{id}`.replace(
'{id}',
encodeURIComponent(String(requestParameters.id))
),
method: 'DELETE',
},
initOverrides
);

return runtime.VoidApiResponse.fromResponse(response);
}

/**
* Delete template for New Universal Login Experience
*
Expand Down Expand Up @@ -246,6 +309,59 @@ export class BrandingManager extends BaseAPI {
return runtime.JSONApiResponse.fromResponse(response);
}

/**
* Get a phone notification template
*
* @throws {RequiredError}
*/
async getPhoneTemplate(
requestParameters: GetPhoneTemplateRequest,
initOverrides?: InitOverride
): Promise<ApiResponse<GetPhoneTemplateResponseContent>> {
runtime.validateRequiredRequestParams(requestParameters, ['id']);

const response = await this.request(
{
path: `/branding/phone/templates/{id}`.replace(
'{id}',
encodeURIComponent(String(requestParameters.id))
),
method: 'GET',
},
initOverrides
);

return runtime.JSONApiResponse.fromResponse(response);
}

/**
* Get a list of phone notification templates
*
* @throws {RequiredError}
*/
async getAllPhoneTemplates(
requestParameters: GetPhoneTemplatesRequest = {},
initOverrides?: InitOverride
): Promise<ApiResponse<ListPhoneTemplatesResponseContent>> {
const queryParameters = runtime.applyQueryParams(requestParameters, [
{
key: 'disabled',
config: {},
},
]);

const response = await this.request(
{
path: `/branding/phone/templates`,
method: 'GET',
query: queryParameters,
},
initOverrides
);

return runtime.JSONApiResponse.fromResponse(response);
}

/**
* Get template for New Universal Login Experience
*
Expand Down Expand Up @@ -404,6 +520,38 @@ export class BrandingManager extends BaseAPI {
return runtime.VoidApiResponse.fromResponse(response);
}

/**
* Resets a phone notification template values
*
* @throws {RequiredError}
*/
async resetTemplate(
requestParameters: ResetPhoneTemplateRequest,
bodyParameters: any | null,
initOverrides?: InitOverride
): Promise<ApiResponse<ResetPhoneTemplateResponseContent>> {
runtime.validateRequiredRequestParams(requestParameters, ['id']);

const headerParameters: runtime.HTTPHeaders = {};

headerParameters['Content-Type'] = 'application/json';

const response = await this.request(
{
path: `/branding/phone/templates/{id}/reset`.replace(
'{id}',
encodeURIComponent(String(requestParameters.id))
),
method: 'PATCH',
headers: headerParameters,
body: bodyParameters as any,
},
initOverrides
);

return runtime.JSONApiResponse.fromResponse(response);
}

/**
* Update a <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</a>.
* The <code>credentials</code> object requires different properties depending on the phone provider (which is specified using the <code>name</code> property).
Expand Down Expand Up @@ -438,4 +586,36 @@ export class BrandingManager extends BaseAPI {

return runtime.JSONApiResponse.fromResponse(response);
}

/**
* Update a phone notification template
*
* @throws {RequiredError}
*/
async updatePhoneTemplate(
requestParameters: UpdatePhoneTemplateRequest,
bodyParameters: UpdatePhoneTemplateRequestContent,
initOverrides?: InitOverride
): Promise<ApiResponse<UpdatePhoneTemplateResponseContent>> {
runtime.validateRequiredRequestParams(requestParameters, ['id']);

const headerParameters: runtime.HTTPHeaders = {};

headerParameters['Content-Type'] = 'application/json';

const response = await this.request(
{
path: `/branding/phone/templates/{id}`.replace(
'{id}',
encodeURIComponent(String(requestParameters.id))
),
method: 'PATCH',
headers: headerParameters,
body: bodyParameters,
},
initOverrides
);

return runtime.JSONApiResponse.fromResponse(response);
}
}
Loading
Loading