apps_metadata_info_localizations.go

/**
Copyright (C) 2020 Aaron Sky.

This file is part of asc-go, a package for working with Apple's
App Store Connect API.

asc-go is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

asc-go is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with asc-go.  If not, see <http://www.gnu.org/licenses/>.
*/

package asc

import (
	"context"
	"fmt"
)

// AppInfoLocalization defines model for AppInfoLocalization.
//
// https://developer.apple.com/documentation/appstoreconnectapi/appinfolocalization
type AppInfoLocalization struct {
	Attributes    *AppInfoLocalizationAttributes    `json:"attributes,omitempty"`
	ID            string                            `json:"id"`
	Links         ResourceLinks                     `json:"links"`
	Relationships *AppInfoLocalizationRelationships `json:"relationships,omitempty"`
	Type          string                            `json:"type"`
}

// AppInfoLocalizationAttributes defines model for AppInfoLocalization.Attributes
//
// https://developer.apple.com/documentation/appstoreconnectapi/appinfolocalization/attributes
type AppInfoLocalizationAttributes struct {
	Locale            *string `json:"locale,omitempty"`
	Name              *string `json:"name,omitempty"`
	PrivacyPolicyText *string `json:"privacyPolicyText,omitempty"`
	PrivacyPolicyURL  *string `json:"privacyPolicyUrl,omitempty"`
	Subtitle          *string `json:"subtitle,omitempty"`
}

// AppInfoLocalizationRelationships defines model for AppInfoLocalization.Relationships
//
// https://developer.apple.com/documentation/appstoreconnectapi/appinfolocalization/relationships
type AppInfoLocalizationRelationships struct {
	AppInfo *Relationship `json:"appInfo,omitempty"`
}

// appInfoLocalizationCreateRequest defines model for AppInfoLocalizationCreateRequest.
//
// https://developer.apple.com/documentation/appstoreconnectapi/appinfolocalizationcreaterequest/data
type appInfoLocalizationCreateRequest struct {
	Attributes    AppInfoLocalizationCreateRequestAttributes    `json:"attributes"`
	Relationships appInfoLocalizationCreateRequestRelationships `json:"relationships"`
	Type          string                                        `json:"type"`
}

// AppInfoLocalizationCreateRequestAttributes are attributes for AppInfoLocalizationCreateRequest
//
// https://developer.apple.com/documentation/appstoreconnectapi/appinfolocalizationcreaterequest/data/attributes
type AppInfoLocalizationCreateRequestAttributes struct {
	Locale            string  `json:"locale"`
	Name              *string `json:"name,omitempty"`
	PrivacyPolicyText *string `json:"privacyPolicyText,omitempty"`
	PrivacyPolicyURL  *string `json:"privacyPolicyUrl,omitempty"`
	Subtitle          *string `json:"subtitle,omitempty"`
}

// AppInfoLocalizationCreateRequestRelationships are relationships for AppInfoLocalizationCreateRequest
//
// https://developer.apple.com/documentation/appstoreconnectapi/appinfolocalizationcreaterequest/data/relationships
type appInfoLocalizationCreateRequestRelationships struct {
	AppInfo relationshipDeclaration `json:"appInfo"`
}

// AppInfoLocalizationResponse defines model for AppInfoLocalizationResponse.
//
// https://developer.apple.com/documentation/appstoreconnectapi/appinfolocalizationresponse
type AppInfoLocalizationResponse struct {
	Data  AppInfoLocalization `json:"data"`
	Links DocumentLinks       `json:"links"`
}

// appInfoLocalizationUpdateRequest defines model for AppInfoLocalizationUpdateRequest.
//
// https://developer.apple.com/documentation/appstoreconnectapi/appinfolocalizationupdaterequest/data
type appInfoLocalizationUpdateRequest struct {
	Attributes *AppInfoLocalizationUpdateRequestAttributes `json:"attributes,omitempty"`
	ID         string                                      `json:"id"`
	Type       string                                      `json:"type"`
}

// AppInfoLocalizationUpdateRequestAttributes are attributes for AppInfoLocalizationUpdateRequest
//
// https://developer.apple.com/documentation/appstoreconnectapi/appinfolocalizationupdaterequest/data/attributes
type AppInfoLocalizationUpdateRequestAttributes struct {
	Name              *string `json:"name,omitempty"`
	PrivacyPolicyText *string `json:"privacyPolicyText,omitempty"`
	PrivacyPolicyURL  *string `json:"privacyPolicyUrl,omitempty"`
	Subtitle          *string `json:"subtitle,omitempty"`
}

// AppInfoLocalizationsResponse defines model for AppInfoLocalizationsResponse.
//
// https://developer.apple.com/documentation/appstoreconnectapi/appinfolocalizationsresponse
type AppInfoLocalizationsResponse struct {
	Data  []AppInfoLocalization `json:"data"`
	Links PagedDocumentLinks    `json:"links"`
	Meta  *PagingInformation    `json:"meta,omitempty"`
}

// ListAppInfoLocalizationsForAppInfoQuery are query options for ListAppInfoLocalizationsForAppInfo
//
// https://developer.apple.com/documentation/appstoreconnectapi/list_all_app_info_localizations_for_an_app_info
type ListAppInfoLocalizationsForAppInfoQuery struct {
	FieldsAppInfos             []string `url:"fields[appInfos],omitempty"`
	FieldsAppInfoLocalizations []string `url:"fields[appInfoLocalizations],omitempty"`
	Limit                      int      `url:"limit,omitempty"`
	Include                    []string `url:"include,omitempty"`
	FilterLocale               []string `url:"filter[locale],omitempty"`
	Cursor                     string   `url:"cursor,omitempty"`
}

// GetAppInfoLocalizationQuery are query options for GetAppInfoLocalization
//
// https://developer.apple.com/documentation/appstoreconnectapi/read_app_info_localization_information
type GetAppInfoLocalizationQuery struct {
	FieldsAppInfoLocalizations []string `url:"fields[appInfoLocalizations],omitempty"`
	Include                    []string `url:"include,omitempty"`
}

// ListAppInfoLocalizationsForAppInfo gets a list of localized, app-level information for an app.
//
// https://developer.apple.com/documentation/appstoreconnectapi/list_all_app_info_localizations_for_an_app_info
func (s *AppsService) ListAppInfoLocalizationsForAppInfo(ctx context.Context, id string, params *ListAppInfoLocalizationsForAppInfoQuery) (*AppInfoLocalizationsResponse, *Response, error) {
	url := fmt.Sprintf("appInfos/%s/appInfoLocalizations", id)
	res := new(AppInfoLocalizationsResponse)
	resp, err := s.client.get(ctx, url, params, res)

	return res, resp, err
}

// GetAppInfoLocalization reads localized app-level information.
//
// https://developer.apple.com/documentation/appstoreconnectapi/read_app_info_localization_information
func (s *AppsService) GetAppInfoLocalization(ctx context.Context, id string, params *GetAppInfoLocalizationQuery) (*AppInfoLocalizationResponse, *Response, error) {
	url := fmt.Sprintf("appInfoLocalizations/%s", id)
	res := new(AppInfoLocalizationResponse)
	resp, err := s.client.get(ctx, url, params, res)

	return res, resp, err
}

// CreateAppInfoLocalization adds app-level localized information for a new locale.
//
// https://developer.apple.com/documentation/appstoreconnectapi/create_an_app_info_localization
func (s *AppsService) CreateAppInfoLocalization(ctx context.Context, attributes AppInfoLocalizationCreateRequestAttributes, appInfoID string) (*AppInfoLocalizationResponse, *Response, error) {
	req := appInfoLocalizationCreateRequest{
		Attributes: attributes,
		Relationships: appInfoLocalizationCreateRequestRelationships{
			AppInfo: relationshipDeclaration{
				Data: RelationshipData{
					ID:   appInfoID,
					Type: "appInfos",
				},
			},
		},
		Type: "appInfoLocalizations",
	}
	res := new(AppInfoLocalizationResponse)
	resp, err := s.client.post(ctx, "appInfoLocalizations", newRequestBody(req), res)

	return res, resp, err
}

// UpdateAppInfoLocalization modifies localized app-level information for a particular language.
//
// https://developer.apple.com/documentation/appstoreconnectapi/modify_an_app_info_localization
func (s *AppsService) UpdateAppInfoLocalization(ctx context.Context, id string, attributes *AppInfoLocalizationUpdateRequestAttributes) (*AppInfoLocalizationResponse, *Response, error) {
	req := appInfoLocalizationUpdateRequest{
		Attributes: attributes,
		ID:         id,
		Type:       "appInfoLocalizations",
	}
	url := fmt.Sprintf("appInfoLocalizations/%s", id)
	res := new(AppInfoLocalizationResponse)
	resp, err := s.client.patch(ctx, url, newRequestBody(req), res)

	return res, resp, err
}

// DeleteAppInfoLocalization deletes an app information localization that is associated with an app.
//
// https://developer.apple.com/documentation/appstoreconnectapi/delete_an_app_info_localization
func (s *AppsService) DeleteAppInfoLocalization(ctx context.Context, id string) (*Response, error) {
	url := fmt.Sprintf("appInfoLocalizations/%s", id)

	return s.client.delete(ctx, url, nil)
}