@victorycode/sdk 0.0.0-stage → 1.0.0

package/docs/UploadsApi.md

@@ -0,0 +1,230 @@
+# UploadsApi
+
+All URIs are relative to *https://sandbox.api.tactixai.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**completeMultipartUpload**](UploadsApi.md#completemultipartupload) | **POST** /api/v1/client/complete-upload | Complete a multipart upload to S3 |
+| [**getPresignedUrl**](UploadsApi.md#getpresignedurl) | **GET** /api/v1/client/upload-presigned-url | Get a presigned URL for a specific part of a multipart upload |
+| [**initiateUpload**](UploadsApi.md#initiateupload) | **POST** /api/v1/client/initiate-upload | Initiate a multipart upload to S3 for a large file |
+
+
+
+## completeMultipartUpload
+
+> CompleteMultipartUploadResponseDto completeMultipartUpload(completeMultipartUploadDto)
+
+Complete a multipart upload to S3
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UploadsApi,
+} from '@victorycode/sdk';
+import type { CompleteMultipartUploadRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new UploadsApi(config);
+
+  const body = {
+    // CompleteMultipartUploadDto
+    completeMultipartUploadDto: ...,
+  } satisfies CompleteMultipartUploadRequest;
+
+  try {
+    const data = await api.completeMultipartUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **completeMultipartUploadDto** | [CompleteMultipartUploadDto](CompleteMultipartUploadDto.md) |  | |
+
+### Return type
+
+[**CompleteMultipartUploadResponseDto**](CompleteMultipartUploadResponseDto.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Presigned URL for part generated successfully. |  -  |
+| **400** | Validation error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPresignedUrl
+
+> GetPartsPresignUrlResponseDto getPresignedUrl(uploadId, partNumber)
+
+Get a presigned URL for a specific part of a multipart upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UploadsApi,
+} from '@victorycode/sdk';
+import type { GetPresignedUrlRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new UploadsApi(config);
+
+  const body = {
+    // string
+    uploadId: uploadId_example,
+    // number
+    partNumber: 8.14,
+  } satisfies GetPresignedUrlRequest;
+
+  try {
+    const data = await api.getPresignedUrl(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **uploadId** | `string` |  | [Defaults to `undefined`] |
+| **partNumber** | `number` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPartsPresignUrlResponseDto**](GetPartsPresignUrlResponseDto.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Presigned URL for part generated successfully. |  -  |
+| **400** | Validation error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## initiateUpload
+
+> InitiateMultipartUploadResponseDto initiateUpload(initiateMultipartUploadDto)
+
+Initiate a multipart upload to S3 for a large file
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UploadsApi,
+} from '@victorycode/sdk';
+import type { InitiateUploadRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new UploadsApi(config);
+
+  const body = {
+    // InitiateMultipartUploadDto
+    initiateMultipartUploadDto: ...,
+  } satisfies InitiateUploadRequest;
+
+  try {
+    const data = await api.initiateUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **initiateMultipartUploadDto** | [InitiateMultipartUploadDto](InitiateMultipartUploadDto.md) |  | |
+
+### Return type
+
+[**InitiateMultipartUploadResponseDto**](InitiateMultipartUploadResponseDto.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Multipart upload initiated successfully, returns uploadId. |  -  |
+| **400** | Validation error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/Venue.md

@@ -0,0 +1,40 @@
+
+# Venue
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`playingSurface` | string
+`address` | [Address](Address.md)
+`coordinates` | [Coordinates](Coordinates.md)
+
+## Example
+
+```typescript
+import type { Venue } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Lincoln Financial Field,
+  "playingSurface": Natural Grass,
+  "address": null,
+  "coordinates": null,
+} satisfies Venue
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Venue
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/VenueApi.md

@@ -0,0 +1,325 @@
+# VenueApi
+
+All URIs are relative to *https://sandbox.api.tactixai.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createVenue**](VenueApi.md#createvenue) | **POST** /api/v1/client/venue | Create a new venue |
+| [**deleteVenue**](VenueApi.md#deletevenue) | **DELETE** /api/v1/client/venue/{id} | Delete a venue |
+| [**getVenues**](VenueApi.md#getvenues) | **GET** /api/v1/client/venues | Get all venues |
+| [**updateVenue**](VenueApi.md#updatevenue) | **PATCH** /api/v1/client/venue/{id} | Update a venue |
+
+
+
+## createVenue
+
+> SingleVenueResponseDto createVenue(createVenueDto)
+
+Create a new venue
+
+Registers a new venue where games are held, including details about the venue name and location.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VenueApi,
+} from '@victorycode/sdk';
+import type { CreateVenueRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new VenueApi(config);
+
+  const body = {
+    // CreateVenueDto
+    createVenueDto: ...,
+  } satisfies CreateVenueRequest;
+
+  try {
+    const data = await api.createVenue(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createVenueDto** | [CreateVenueDto](CreateVenueDto.md) |  | |
+
+### Return type
+
+[**SingleVenueResponseDto**](SingleVenueResponseDto.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Venue created successfully. |  -  |
+| **400** |  |  -  |
+| **401** |  |  -  |
+| **409** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteVenue
+
+> DeleteResponseDto deleteVenue(id)
+
+Delete a venue
+
+Permanently removes a venue registration from the system.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VenueApi,
+} from '@victorycode/sdk';
+import type { DeleteVenueRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new VenueApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies DeleteVenueRequest;
+
+  try {
+    const data = await api.deleteVenue(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeleteResponseDto**](DeleteResponseDto.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Venue deleted successfully. |  -  |
+| **400** |  |  -  |
+| **401** |  |  -  |
+| **404** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getVenues
+
+> ListVenuePaginatedResponseDto getVenues(limit, page, search)
+
+Get all venues
+
+Retrieves a paginated list of all venues where sports events or games are conducted.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VenueApi,
+} from '@victorycode/sdk';
+import type { GetVenuesRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new VenueApi(config);
+
+  const body = {
+    // number (optional)
+    limit: 8.14,
+    // number (optional)
+    page: 8.14,
+    // string (optional)
+    search: search_example,
+  } satisfies GetVenuesRequest;
+
+  try {
+    const data = await api.getVenues(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **limit** | `number` |  | [Optional] [Defaults to `10`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **search** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListVenuePaginatedResponseDto**](ListVenuePaginatedResponseDto.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of venues retrieved successfully. |  -  |
+| **400** |  |  -  |
+| **401** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateVenue
+
+> SingleVenueResponseDto updateVenue(id, updateVenueDto)
+
+Update a venue
+
+Updates the information of an existing venue currently registered in the system.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VenueApi,
+} from '@victorycode/sdk';
+import type { UpdateVenueRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new VenueApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+    // UpdateVenueDto
+    updateVenueDto: ...,
+  } satisfies UpdateVenueRequest;
+
+  try {
+    const data = await api.updateVenue(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **updateVenueDto** | [UpdateVenueDto](UpdateVenueDto.md) |  | |
+
+### Return type
+
+[**SingleVenueResponseDto**](SingleVenueResponseDto.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Venue updated successfully. |  -  |
+| **400** |  |  -  |
+| **401** |  |  -  |
+| **404** |  |  -  |
+| **409** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/VideoListItemDto.md

@@ -0,0 +1,42 @@
+
+# VideoListItemDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`gameId` | string
+`videoId` | string
+`viewType` | string
+`sourceUrl` | string
+`isDefaultVideo` | boolean
+
+## Example
+
+```typescript
+import type { VideoListItemDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "gameId": game-id,
+  "videoId": video-id,
+  "viewType": All-22 Sideline,
+  "sourceUrl": https://example.com/video.mp4,
+  "isDefaultVideo": false,
+} satisfies VideoListItemDto
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as VideoListItemDto
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,26 @@
 {
   "name": "@victorycode/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "OpenAPI client for @victorycode/sdk",
+  "author": "Victory Code",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/victory-code-ai/victorycode-sdks.git",
+    "directory": "javascript"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "license": "MIT"
+}