nsdl.go

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

package casparser

import (
	"context"
	"net/http"
	"slices"

	"github.com/CASParser/cas-parser-go/internal/apijson"
	"github.com/CASParser/cas-parser-go/internal/requestconfig"
	"github.com/CASParser/cas-parser-go/option"
	"github.com/CASParser/cas-parser-go/packages/param"
)

// Endpoints for parsing CAS PDF files from different sources.
//
// NsdlService contains methods and other services that help with interacting with
// the cas-parser API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewNsdlService] method instead.
type NsdlService struct {
	Options []option.RequestOption
}

// NewNsdlService generates a new service that applies the given options to each
// request. These options are applied after the parent client's options (if there
// is one), and before any request-specific options.
func NewNsdlService(opts ...option.RequestOption) (r NsdlService) {
	r = NsdlService{}
	r.Options = opts
	return
}

// This endpoint specifically parses NSDL CAS (Consolidated Account Statement) PDF
// files and returns data in a unified format. Use this endpoint when you know the
// PDF is from NSDL.
func (r *NsdlService) Parse(ctx context.Context, body NsdlParseParams, opts ...option.RequestOption) (res *UnifiedResponse, err error) {
	opts = slices.Concat(r.Options, opts)
	path := "v4/nsdl/parse"
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
	return res, err
}

type NsdlParseParams struct {
	// Password for the PDF file (if required)
	Password param.Opt[string] `json:"password,omitzero"`
	// Base64 encoded CAS PDF file (required if pdf_url not provided)
	PdfFile param.Opt[string] `json:"pdf_file,omitzero" format:"base64"`
	// URL to the CAS PDF file (required if pdf_file not provided)
	PdfURL param.Opt[string] `json:"pdf_url,omitzero" format:"uri"`
	paramObj
}

func (r NsdlParseParams) MarshalJSON() (data []byte, err error) {
	type shadow NsdlParseParams
	return param.MarshalObject(r, (*shadow)(&r))
}
func (r *NsdlParseParams) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}